# SABS_AGV_BACK

**Repository Path**: ralphkong/sabs_agv_back

## Basic Information

- **Project Name**: SABS_AGV_BACK
- **Description**: SABSAGV系统后台
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2022-02-07
- **Last Updated**: 2022-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 项目介绍
  {TODO 项目介绍}


## 开发说明

### DAO层
	工程中利用Mybatis Generator自动生产实体类以及Dao层方法，下面介绍生成过程：
	1、配置generatorConfig.xml文件，文件中配置了连接的数据库、所有生成的表，以及生成生成文件的位置，根据实际做相应修改；
	2、 利用maven命令 mvn mybatis-generator:generate 生成对应的实体类,DAO层方法以及Mapper文件。
	
	注意：工程使用tk.mybatis实现单表操作，自动生成的DAO中添加自定义方法可以实现自定义数据库操作，同时在mapper xml中编写SQL 与 ResultMap;

### Service层
	Service层返回Controller需要的数据或操作结果，或者抛出异常，建议抛出自定义异常（ServiceException）；
	禁止在Service层直接返回Http消息。

### Controller层
	工程利用Swagger进行接口文档管理，在类config.SwaggerConfig中，可进行相关配置。
	运行工程，打开 http://localhost:8089/swagger-ui.html 可以进入swagger 接口文档界面。
	采用Swagger注解@ApiOperation，@ApiImplicitParams对接口进行详细说明
	
### 统一返回消息格式
	工程建议接口设计符合RESTFUL风格设计，对于API返回结果遵循以下结构
	{
		status: 100,
		message: '',
		data: []
	}
	其中status定义可在response.RespStatusCode中进行定义

### 统一异常处理
	工程使用@RestControllerAdvice实现统一异常处理，具体配置在config.ExceptionControllerAdvice类中进行配置，可以再其中增加起来类型异常处理方式

### 代码日志
	代码中使用Slf4j记录代码运行日志.
	```
	import lombok.extern.slf4j.Slf4j;
	@Slf4j
	class  Test{
	
	//引入logger类
	private final Logger logger = LoggerFactory.getLogger(Test.class);
	
	//....other code
	
	log.info("info {}", "...");
	log.error("error");
	log.warn("warn");
	```
	项目日志配置文件logback-spring.xml中可以配置具体的日志行为，包括日志等级（可按不同环境区别），日志保存路径等

### 配置
	application.xml中定义项目基本参数，按照生产和测试环境分为application-prod.xml 和 application-dev.xml

### Druid监控
	工程默认开启Druid监控功能，包括SQL监控和Http监控，具体配置在config.DruidConfiguration中
	监控地址为http://localhost:8089/druid/index.html

### 项目打包与部署
	打包指令: mvn clean package -DskipTests
	部署方式一：jar包 + Winsw 在Windows上部署；
	部署方式二：war包 + Tomcat 部署， 该方式需调整POM配置，以war方式打包