Bowler框架技术文档

1. 安装指南

环境准备

• 确保已安装Scala和Java开发环境。
• 安装Simple Build Tool (sbt) 0.7.5RC0或更高版本。

依赖项安装

1. 克隆并构建Recursivity Commons项目。
2. 在Recursivity Commons项目目录下运行publish-local命令，以便Bowler框架能够依赖此项目。

项目构建

1. 进入Bowler项目的core文件夹。
2. 运行sbt命令，然后在sbt控制台中执行update命令，以下载所有依赖项。
3. 将scala-compiler.jar文件放置在lib文件夹中，这是Scalate的依赖项，由于sbt的一个bug，它不会自动下载。

构建完成

• 现在您已经准备好构建和运行Bowler项目了。

2. 项目的使用说明

概述

Bowler是一个基于Scalatra和Scalate的RESTful、多渠道支持的Scala Web框架，具有函数式编程风格。它旨在遵循RESTful原则，并支持多种客户端平台（如桌面浏览器、智能手机、平板电脑和第三方API）。

主要特性

• RESTfulness：严格遵循RESTful原则和HTTP协议的意图。
• 多渠道支持：支持多种客户端平台，通过最大化重用和最小化重做来简化多平台开发。
• JSON API：默认提供JSON API，便于创建动态网站或为合作伙伴提供API。
• 视图分解：将视图分解为“资源视图”和布局，严格分离模型显示和布局。
• 合理默认值：开箱即用，提供合理的默认设置，并支持进一步的功能扩展和插件。
• 组合性：遵循单一职责原则，允许用户选择和组合所需的功能模块。

使用示例

• 创建一个RESTful控制器，处理HTTP请求并返回JSON响应。
• 使用Scalate模板引擎定义视图和布局。
• 根据用户代理、域名等条件选择不同的布局和模板。

3. 项目API使用文档

控制器API

• GET /resource：获取资源列表。
• POST /resource：创建新资源。
• GET /resource/:id：获取指定ID的资源。
• PUT /resource/:id：更新指定ID的资源。
• DELETE /resource/:id：删除指定ID的资源。

JSON API

• 默认情况下，Bowler会根据视图模型和HTTP Accept头自动渲染JSON响应。
• 可以通过设置HTTP Accept头为application/json来请求JSON格式的响应。

视图和布局API

• ResourceView：表示要显示的模型。
• Layout：表示要围绕模型显示的布局。
• 可以通过配置选择不同的布局和模板。

4. 项目安装方式

手动安装

1. 克隆Bowler项目仓库。
2. 按照“安装指南”中的步骤配置和构建项目。

自动安装

• 未来计划通过Maven仓库提供自动安装方式，敬请期待。

---

通过以上文档，您应该能够顺利安装、使用和理解Bowler框架。如有任何问题，请参考项目网站或联系项目维护者。