# autumn

**Repository Path**: autumn-code/autumn

## Basic Information

- **Project Name**: autumn
- **Description**: No description available
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2018-03-25
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Autumn（后台）

## 开发环境

### 1、环境构建

* 前往Oracle官网下载[JDK 1.8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)或更高版本，安装
* 前往Spring官网下载[STS 3.9.2](https://spring.io/tools/sts/all)或更高版本 (基于Eclipse Oxygen.2 (4.7.2))，并解压
* 设置STS工作空间，如编码统一为UTF-8、设置Maven（版本库中有设置文件/docs/java/settings.xml）、安装的JDK等
* 切换到`Git`的透视图，添加git资源，输入项目版本库地址 `https://gitee.com/autumn-code/autumn.git`
* 选中Git仓库，单击右键，选择`Import Projects...`导入Eclipse本地项目（注意，需要勾选嵌套搜索，一并导入所有子项目）

### 2、启动调试

* 切换到`Spring`的透视图，选择`Boot Dashboard`,调试模式启动即可。也可选中`autumn-demo`项目，右键`Debug As`——>`Spring Boot App`。
* 项目配置可修改`application.yml`

### 3、代码格式化文件

* 在STS中依次选择`Window`——>`Preferences`——>`Java`——>`Code Style`——>`Formatter`，然后点击`Import...`导入代码格式化文件`docs/java/Java-CodeStyle.xml`
> 该文件是在Google的Java规范基础之上做了少量调整而生成
* 建议启用保存时自动格式化的选项，具体启用方法是：依次选择`Window`——>`Preferences`——>`Java`——>`Editor`——>`Save Actions`，选择`Format all lines`,然后点击`Apply`即可。
> 可以看到，保存时除了自动格式化之外，还可以自动导入类、自动清除不需要到导入、自动添加@Override注解等，建议将这些选项也勾选上。

### 4、设置lombok

* 为了简化Java代码开发，本项目引入了[lombok](https://projectlombok.org/)类库，并且已经在pom.xml中添加依赖，但如果需要使用IDE的编译器，则需要双击lombok对应的jar包，然后选择IDE可执行文件，进行设置

### 5、工具类

* 工具类
  * 异常工具类：`Throws`
  * 日志工具类：`Logs`
  * 一般工具类：`Utils`

### 6、API调用示例

* 可以通过访问[API调用示例](http://localhost:8080/autumn-demo/api-test.html)来查看`v1/demo/cruds`示例模块的API调用(暂不支持代码编辑)。
* 建议按如下顺序查看示例
  * 点击`Find`，此时因为没有id为testUserId的用户，查询出的data为null
  * 点击`Create`，创建id为testUserId的用户，返回的data中包含服务器自动生成的用户内部ID
  * 再次点击`Find`，查询出的data为刚刚创建的用户信息
  * 点击`Update`，修改用户名为`测试(修改后)`
  * 再次点击`Find`，查询出的data为刚刚修改后的用户信息
  * 点击`Delete`，删除id为testUserId的用户
  * 再次点击`Find`，没有id为testUserId的用户，查询出的data为null

### 7、开发流程

* 下载主分支
* 基于主分支在本地创建开发分支
* 在开发分支修改
* `pull`主分支，并在本地将主分支合并至开发分支
* 提交开发分支，并推送`push`开发分支至远程仓库
* 基于远程仓库的开发分支，发起`PR`请求，等待管理员合并代码