Kitty-Cloud中的编码规范

2023-11-05 14:40
文章标签 cloud 编码 规范 kitty

本文主要是介绍Kitty-Cloud中的编码规范,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

项目地址

https://github.com/yinjihuan/kitty-cloud[1]

规范定义

每个公司,每个团队都有不同的规范,有的人喜欢这样,有的人喜欢那样。所以一个团队中最好有明确的一份规范,这样代码看起来就会很清爽。

本文只写了一些最基本的,更全的大家可以参考阿里编码规范。

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。

注释规范

类注释:必须要有,说明类的作用。

/*** 评论业务接口** @作者 尹吉欢* @个人微信 jihuan900* @微信公众号 猿天地* @GitHub https://github.com/yinjihuan* @作者介绍 http://cxytiandi.com/about* @时间 2020-02-13 20:44:04*/

方法注释:必须要有,说明方法的作用。

/*** 保存评论* @param param 评论参数* @return 评论ID*/
String saveComment(CommentSaveParam param);

字段注释:必须要有,说明字段的作用。

/*** 评论保存参数** @作者 尹吉欢* @个人微信 jihuan900* @微信公众号 猿天地* @GitHub https://github.com/yinjihuan* @作者介绍 http://cxytiandi.com/about* @时间 2020-02-13 20:44:04*/
@Data
public class CommentSaveParam {/*** 评论内容*/private String content;/*** 评论业务类型*/private int commentBizType;/*** 评论业务ID*/private String commentBizId;/*** 评论业务的用户ID*/private Long commentBizUserId;/*** 用户ID*/private Long userId;
}

参考资料

[1]

kitty-cloud: https://github.com/yinjihuan/kitty-cloud

关于作者:尹吉欢,简单的技术爱好者,《Spring Cloud 微服务-全栈技术与案例解析》, 《Spring Cloud 微服务 入门 实战与进阶》作者, 公众号 猿天地 发起人。个人微信 jihuan900, 欢迎勾搭。

相关推荐

  • 双剑合璧的开源项目Kitty-Cloud

  • Kitty-Cloud环境准备

  • Kitty-Cloud服务搭建过程剖析

扫下面的码加技术群,广告勿扰

如有收获,点个在看,诚挚感谢

这篇关于Kitty-Cloud中的编码规范的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/350542

相关文章

JSR-107缓存规范介绍

《JSR-107缓存规范介绍》JSR是JavaSpecificationRequests的缩写,意思是Java规范提案,下面给大家介绍JSR-107缓存规范的相关知识,感兴趣的朋友一起看看吧... 目录1.什么是jsR-1072.应用调用缓存图示3.JSR-107规范使用4.Spring 缓存机制缓存是每一

Spring Cloud GateWay搭建全过程

《SpringCloudGateWay搭建全过程》:本文主要介绍SpringCloudGateWay搭建全过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录Spring Cloud GateWay搭建1.搭建注册中心1.1添加依赖1.2 配置文件及启动类1.3 测

基于Go语言实现Base62编码的三种方式以及对比分析

《基于Go语言实现Base62编码的三种方式以及对比分析》Base62编码是一种在字符编码中使用62个字符的编码方式,在计算机科学中,,Go语言是一种静态类型、编译型语言,它由Google开发并开源,... 目录一、标准库现状与解决方案1. 标准库对比表2. 解决方案完整实现代码(含边界处理)二、关键实现细

浅谈Redis Key 命名规范文档

《浅谈RedisKey命名规范文档》本文介绍了Redis键名命名规范,包括命名格式、具体规范、数据类型扩展命名、时间敏感型键名、规范总结以及实际应用示例,感兴趣的可以了解一下... 目录1. 命名格式格式模板:示例:2. 具体规范2.1 小写命名2.2 使用冒号分隔层级2.3 标识符命名3. 数据类型扩展命

解决IDEA报错:编码GBK的不可映射字符问题

《解决IDEA报错:编码GBK的不可映射字符问题》:本文主要介绍解决IDEA报错:编码GBK的不可映射字符问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录IDEA报错:编码GBK的不可映射字符终端软件问题描述原因分析解决方案方法1:将命令改为方法2:右下jav

Python使用自带的base64库进行base64编码和解码

《Python使用自带的base64库进行base64编码和解码》在Python中,处理数据的编码和解码是数据传输和存储中非常普遍的需求,其中,Base64是一种常用的编码方案,本文我将详细介绍如何使... 目录引言使用python的base64库进行编码和解码编码函数解码函数Base64编码的应用场景注意

SpringCloud负载均衡spring-cloud-starter-loadbalancer解读

《SpringCloud负载均衡spring-cloud-starter-loadbalancer解读》:本文主要介绍SpringCloud负载均衡spring-cloud-starter-loa... 目录简述主要特点使用负载均衡算法1. 轮询负载均衡策略(Round Robin)2. 随机负载均衡策略(

Spring、Spring Boot、Spring Cloud 的区别与联系分析

《Spring、SpringBoot、SpringCloud的区别与联系分析》Spring、SpringBoot和SpringCloud是Java开发中常用的框架,分别针对企业级应用开发、快速开... 目录1. Spring 框架2. Spring Boot3. Spring Cloud总结1. Sprin

VSCode中C/C++编码乱码问题的两种解决方法

《VSCode中C/C++编码乱码问题的两种解决方法》在中国地区,Windows系统中的cmd和PowerShell默认编码是GBK,但VSCode默认使用UTF-8编码,这种编码不一致会导致在VSC... 目录问题方法一:通过 Code Runner 插件调整编码配置步骤方法二:在 PowerShell

Spring Cloud之注册中心Nacos的使用详解

《SpringCloud之注册中心Nacos的使用详解》本文介绍SpringCloudAlibaba中的Nacos组件,对比了Nacos与Eureka的区别,展示了如何在项目中引入SpringClo... 目录Naacos服务注册/服务发现引⼊Spring Cloud Alibaba依赖引入Naco编程s依