Kitty-Cloud編碼規(guī)范有哪些

API 層

autoconfigure：自動(dòng)配置包名，類名以 AutoConfigure 結(jié)尾，比如 RemoteServiceAutoConfigure。

fallback：Feign 熔斷回退包名，類名以服務(wù)接口名開頭+FallbackFactory 結(jié)尾，比如 ArticleRemoteServiceFallbackFactory。

request：API 參數(shù)類包名，類名以 Request 結(jié)尾，比如 ArticleQueryRequest，ArticleSaveRequest。

response：API 響應(yīng)類包名，類名以 Response 結(jié)尾，比如 ArticleResponse。

service：API 接口定義包名，類名以 RemoteService 結(jié)尾，比如 ArticleRemoteService。

BIZ 層

bo：業(yè)務(wù)對象包名，類名以 BO 結(jié)尾，比如 ArticleBO。

convert：實(shí)體類轉(zhuǎn)換包名，類名以 Convert 結(jié)尾，比如 ArticleBOConvert。

dataobject：數(shù)據(jù)對象（與表對應(yīng)）包名，類名以 DO 結(jié)尾，比如 ArticleDO。

enums：枚舉包名，類名以 Enum 結(jié)尾，比如 ArticleStatusEnum。

manager：三方操作管理（RPC/Http/緩存）包名，類名以 Manager 結(jié)尾，比如 UserManager。

service：業(yè)務(wù)類包名，類名以 Service 結(jié)尾，比如 ArticleService。實(shí)現(xiàn)類放入子包 impl 里面，類名以接口名開頭+Impl 結(jié)尾，比如 ArticleServiceImpl。

config：配置包名（Nacos 配置），類名以 Config 結(jié)尾，比如 ElasticSearchIndexConfig。

param：業(yè)務(wù)層參數(shù)包名，類名以 Param 結(jié)尾，比如 ArticleIndexSaveParam。

document：文檔（MongoDB，ElasticSearch）對象包名，類名以 Document 結(jié)尾，比如 ArticleDocument。

handler：定時(shí)任務(wù)類名以 Handler 結(jié)尾，比如 EsIndexBuildHandler。

PROVIDER 層

convert：實(shí)體類轉(zhuǎn)換包名，類名以 Convert 結(jié)尾，比如 ArticleBOConvert。

service：API 接口實(shí)現(xiàn)包名，類名以 API 接口名開頭+Impl 結(jié)尾，比如 ArticleRemoteServiceImpl。

服務(wù)啟動(dòng)類以 ProviderApp 結(jié)尾。

方法名定義規(guī)范

get：單條數(shù)據(jù)獲取方法名以 get 開頭，比如 getArticle。

list：多條數(shù)據(jù)獲取方法名以 list 開頭，比如 listHotArticles。

save：數(shù)據(jù)保存方法名以 save 開頭，比如 saveComment。

remove：數(shù)據(jù)刪除方法名以 remove 開頭，比如 removeComment。

search：ES 搜索以 search 開頭，比如 searchArticle。

注釋規(guī)范

類注釋：必須要有，說明類的作用。

/**
 * 評論業(yè)務(wù)接口
 *
 * @作者 尹吉?dú)g
 * @個(gè)人微信 jihuan900
 * @微信公眾號 猿天地
 * @GitHub https://github.com/yinjihuan
 * @作者介紹 http://cxytiandi.com/about
 * @時(shí)間 2020-02-13 20:44:04
 */

方法注釋：必須要有，說明方法的作用。

/**
 * 保存評論
 * @param param 評論參數(shù)
 * @return 評論ID
 */
String saveComment(CommentSaveParam param);

字段注釋：必須要有，說明字段的作用。

/**
 * 評論保存參數(shù)
 *
 * @作者 尹吉?dú)g
 * @個(gè)人微信 jihuan900
 * @微信公眾號 猿天地
 * @GitHub https://github.com/yinjihuan
 * @作者介紹 http://cxytiandi.com/about
 * @時(shí)間 2020-02-13 20:44:04
 */
@Data
public class CommentSaveParam {
    /**
     * 評論內(nèi)容
     */
    private String content;
    /**
     * 評論業(yè)務(wù)類型
     */
    private int commentBizType;
    /**
     * 評論業(yè)務(wù)ID
     */
    private String commentBizId;
    /**
     * 評論業(yè)務(wù)的用戶ID
     */
    private Long commentBizUserId;
    /**
     * 用戶ID
     */
    private Long userId;
}

以上就是Kitty-Cloud編碼規(guī)范有哪些，小編相信有部分知識點(diǎn)可能是我們?nèi)粘９ぷ鲿?huì)見到或用到的。希望你能通過這篇文章學(xué)到更多知識。更多詳情敬請關(guān)注億速云行業(yè)資訊頻道。