# base_restful_java_program

**Repository Path**: tatacrayon/base_restful_java_program

## Basic Information

- **Project Name**: base_restful_java_program
- **Description**: 基于SQL生成代码的基本项目：
含基本restful构成类、mp代码自动生成器、根据sql生成表的flyway；
需要手动建库，并配置flyway，修改CodeGenerator参数；
详细说明见README.MD。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2021-09-24
- **Last Updated**: 2022-10-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 1、fork操作说明

操作需要已创建好数据库  
1、编写好V1__init.sql  
2、修改application.yml中的配置信息——数据库连接  
3、启动项目  
4、修改CodeGenerator中配置信息——数据库连接 5、启动CodeGenerator,输入表名

### rsetful格式说明

项目遵循rsetful格式，基本格式为

```json
{
  "code": "xx",
  "msg": "xx",
  "data": ""
}
```

其中，code规则为:RequestStatusCode+BaseCode ，一共8位code。  
前3位RequestStatusCode说明请求状态，后5位说明操作状态

### 2、工程相关文档

---
RESTFUL风格的基本单模块代码工程

#### SpringBoot

* https://docs.spring.io/spring-boot/docs/current/reference/html/index.html

#### 工具包-hutool\guava

* hutool  
  https://www.hutool.cn/docs/#/
* guava  
  https://github.com/google/guava/wiki

#### 持久层-Mybatis-plus

- https://baomidou.com/guide/

#### 文档与接口测试支持-swagger

(openApi3有待调整)

- http://localhost:8080/doc.html

#### 数据库管理-flyway

- ${}

#### 日志管理-logBack

- 日志可以通过logback.xml配置，LogAspect做处理

### 3、工程扩展方向与框架说明

![](applicationStatus.png)

目前aop已经可以处理很多情况，后续视业务情况酌情引用

### 4、可能的问题

---
如若出现 \u914D\u7F6E\u83B7\u53D6\ 且无法用网上设置UTF-8的方法解决  
推荐使用 json parser插件或json在线格式解析，输入值至value解析为中文