# RhythmCourse

**Repository Path**: The_Emperor/RhythmCourse

## Basic Information

- **Project Name**: RhythmCourse
- **Description**: 律动课堂
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2017-07-28
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

1.命名规范

1.1
接口命名规范

修改/更新:update
创建:create
查询:select
删除:delete

接口访问路径都放到接口方法的上面("course/user/register")
这样的好处可以直接通过Ctrl+H查找对应的java代码
或者直接在eolinker里面查询对应的接口规范文档

2.包规范
2.1
包命名规范
com.dy.course为前缀
controller:为接口包
service:服务层
common:大杂烩
util:工具包
mapper:底层数据库

单元测试的包安装main包的机构来

2.2 
类命名规范
工具类:xxxxUtil
服务实现类:xxxxService
服务接口:IxxxxService
控制器类:xxxxController
dao层:xxxxMapper
Service测试类:xxxxServiceTest
Controller测试类:xxxxControllerTest




3.http协议规范
更新,修改,删除数据用post请求,请求格式为applicaiton/json
其他接口用get请求


4.代码注释规范
Service接口中注释方法
其他方法在方法实现里面加注释,分为几个步骤的代码用空行隔开并且加上注释
代码逻辑不直观的加上必要的注释
业务逻辑复杂的代码加上必要注释



5.日志规范
Controller层的第一句是日志:【xxxxx接口】,然后加上参数信息logger.info(msg);
Service的一句【xxxx服务】,加上参数信息logger.info(msg);
凡是跑出异常都要记录异常信息logger.error(msg);
中间结果也需要打印参数logger.info(msg);

6.事务规范
事务统一用注解
Service上要加上@Service注解
分步执行的服务要加上@Transational注释保证数据的一致性

7.异常规范
凡是Service里面的业务逻辑异常都要注明异常码,异常原因
0000:成功
8888:验证错误
9999:系统错误
5000:数据不存在



8.数据验证规范
语言级别的验证和业务逻辑级别的验证
在执行业务逻辑方法之前,先进性数据合法性验证(非空,正则,范围...)
然后进行业务逻辑验证(不需要连表)
然后再进行关联验证(查表,保证业务数据的逻辑一致性和完整性)



发布:
1.mvn clean install -Dmaven.test.skip
2.mvn  tomcat7:deploy

测试:mvn clean install -Dmaven.test.skip -Ptest tomcat7:deploy
如要要运行本地dev环境
运行:mvn clean install -Dmaven.test.skip -Pdev


生产:mvn clean install -Dmaven.test.skip -Pprod tomcat7:deploy
预生产:mvn clean install -Dmaven.test.skip -Pprev tomcat7:deploy