文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

Kitty-Cloud编码规范有哪些

2023-06-03 18:28

关注

本篇文章给大家分享的是有关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;
}

以上就是Kitty-Cloud编码规范有哪些,小编相信有部分知识点可能是我们日常工作会见到或用到的。希望你能通过这篇文章学到更多知识。更多详情敬请关注编程网行业资讯频道。

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯