本篇文章给大家分享的是有关Kitty-Cloud编码规范有哪些,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。
API 层
autoconfigure:自动配置包名,类名以 AutoConfigure 结尾,比如 RemoteServiceAutoConfigure。
fallback:Feign 熔断回退包名,类名以服务接口名开头+FallbackFactory 结尾,比如 ArticleRemoteServiceFallbackFactory。
request:API 参数类包名,类名以 Request 结尾,比如 ArticleQueryRequest,ArticleSaveRequest。
response:API 响应类包名,类名以 Response 结尾,比如 ArticleResponse。
service:API 接口定义包名,类名以 RemoteService 结尾,比如 ArticleRemoteService。
BIZ 层
bo:业务对象包名,类名以 BO 结尾,比如 ArticleBO。
convert:实体类转换包名,类名以 Convert 结尾,比如 ArticleBOConvert。
dataobject:数据对象(与表对应)包名,类名以 DO 结尾,比如 ArticleDO。
enums:枚举包名,类名以 Enum 结尾,比如 ArticleStatusEnum。
manager:三方操作管理(RPC/Http/缓存)包名,类名以 Manager 结尾,比如 UserManager。
service:业务类包名,类名以 Service 结尾,比如 ArticleService。实现类放入子包 impl 里面,类名以接口名开头+Impl 结尾,比如 ArticleServiceImpl。
config:配置包名(Nacos 配置),类名以 Config 结尾,比如 ElasticSearchIndexConfig。
param:业务层参数包名,类名以 Param 结尾,比如 ArticleIndexSaveParam。
document:文档(MongoDB,ElasticSearch)对象包名,类名以 Document 结尾,比如 ArticleDocument。
handler:定时任务类名以 Handler 结尾,比如 EsIndexBuildHandler。
PROVIDER 层
convert:实体类转换包名,类名以 Convert 结尾,比如 ArticleBOConvert。
service:API 接口实现包名,类名以 API 接口名开头+Impl 结尾,比如 ArticleRemoteServiceImpl。
服务启动类以 ProviderApp 结尾。
方法名定义规范
get:单条数据获取方法名以 get 开头,比如 getArticle。
list:多条数据获取方法名以 list 开头,比如 listHotArticles。
save:数据保存方法名以 save 开头,比如 saveComment。
remove:数据删除方法名以 remove 开头,比如 removeComment。
search:ES 搜索以 search 开头,比如 searchArticle。
注释规范
类注释:必须要有,说明类的作用。
方法注释:必须要有,说明方法的作用。
String saveComment(CommentSaveParam param);
字段注释:必须要有,说明字段的作用。
@Data
public class CommentSaveParam {
private String content;
private int commentBizType;
private String commentBizId;
private Long commentBizUserId;
private Long userId;
}