# java-demo

**Repository Path**: rubikyard/java-demo

## Basic Information

- **Project Name**: java-demo
- **Description**: java-demo
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-08-29
- **Last Updated**: 2021-01-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# java-demo
## 数据库版本管理说明
在db目录下，按版本管理建立目录，版本格式<主版本号>.<子版本号>.<修订号1>.<修订号2>，比如v1.0.0.0表示发布的一个数据库版本。每一个版本的发布里面是针对上个版本的数据库升级脚本，并且遵守以下几点规范。
- 数据的升级或者修改，则变动<修订号2>
- 表结构的需改，则变动<修订号1>
- 添加新的表，则变动<子版本号>
- 数据库重大变动，则变动<主版本号>

数据表db_version记录了当前数据库的版本，后续可以做一个脚本程序升级数据库。升级的时候脚本必须按照版本号顺序依次执行，有脚本程序控制。暂时没写这个脚本。

## API文档说明 
前端同学可以通过访问[http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html)查看API的文档说明。

## 接口日志规范
接口实现代码最外层必须一个，并且catch中输出错误日志，如下：
```Java
try {
    // 代码实现
} catch (Throwable t) {
    log.error(t.message, t);
}
```
接口实现中使用INFO级别输出接口接收到的数据。

## 接口单元测试说明
- 每个Controller对应一个ControllerTests，比如DemoController对应一个DemoControllerTests测试类
- 单元测试针对每个REST api

具体参考DemoControllerTest的实现。