java开发编码规范.doc

##java编码规范

###代码目录

-com

+adea

+entry(数据字典)

+bean(DTO、VO等)

+service(服务类)

*impl(实现类)

+mapper(mybatis的mapper)

+controller(spring的controller)

+util(工具类)

###命名相关

命名要尽量间接，并且基于数据字典完成mapper、service、controller的命名设定，

例如：实体类TQaOption（用户答案），需对应生成TQaOptionMapper、ITQaOptionService、TQaOptionServiceImpl和TQaOptionController

###默认使用的包

-spring-boot-starter-parent2.7.1

-mybatis-plus3.5.6

-hutool-all5.7

-fastjson1.2

-lombok1.18.12

-springdoc-openapi-ui

-spring-boot-starter-security

-spring-boot-starter-validation

###关于swagger的使用注意点

-使用@Operation来标记controllerrestful接口方法

-使用@Schema来标记数据实体类

###统一的响应类：

```java

@Data

publicclassResultTimplementsSerializable{

protectedstaticfinalIntegerOK_CODE=IErrorCode.SUCCESS;

protectedstaticfinalStringOK_STRING=成功;

protectedstaticfinalStringOK_STRING_E=success;

protectedIntegercode;

protectedBooleansuccess;

protectedStringmessage;

protectedStringmessageE;//英文回复

protectedTdata;

protectedStringjwt;//jwt

publicstaticResultVoidsuccess(){

ResultVoidresult=newResult();

result.setCode(OK_CODE);

result.setMessage(OK_STRING);

result.setMessageE(OK_STRING_E);

result.setSuccess(Boolean.TRUE);

returnresult;

}

publicstaticTResultTsuccess(Tdata){

ResultTresult=newResult();

result.setCode(OK_CODE);

result.setMessage(OK_STRING);

result.setSuccess(Boolean.TRUE);

result.setMessageE(OK_STRING_E);

result.setData(data);

returnresult;

}

publicstaticResulterror(Integercode,Stringmessage){

Resultresult=newResult();

result.setCode(code);

result.setMessage(message);

result.setMessageE(message);

result.setSuccess(Boolean.FALSE);

returnresult;

}

}

```

###关于controller的使用注意

-需使用swagger进行注释

-配置的url需要结合类名，比如TCategoryMContro