系统设计（一）优秀的代码

我不是女神ヾ 2023-06-30 13:58 21阅读 0赞

# 前言 #

一个优秀的架构师必须是一个优秀的coder，代码编写分为两个层级，代码整洁可读、扩展性好、效率高。

一个应用系统新建之处，就必须有一个编码规范，指导团队相关同学日常开发，笔者认为编码规范可以包含如下几部分，另外可以有bad case 和bad case样板间，指导团队同学开发。

*  系统对外接口规范（出参、入参）
 *  命名规范（函数、方法、类、枚举、常量）
 *  系统分层规范，每一层的入参、出参规范，包命名规范
 *  日志打印规范（非常重要），可以分为拦截器打印和手动打印
 *  配置使用
 *  运维规范（熔断配置、限流配置）
 *  消息使用规范（kafka、msgbroker）
 *  异常处理规范（异常范围、使用场景）
 *  注释（变量、类、方法）
 *  格式化规则
 *  必须使用Java8

# 代码整洁之道 #

下面xmind下载地址

[https://github.com/HelloKittyNII/Knowledge-Library/tree/master/%E7%B3%BB%E7%BB%9F%E8%AE%BE%E8%AE%A1][https_github.com_HelloKittyNII_Knowledge-Library_tree_master_E7_B3_BB_E7_BB_9F_E8_AE_BE_E8_AE_A1]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA4ODk2MTY_size_16_color_FFFFFF_t_70][]

# 设计模式 #

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA4ODk2MTY_size_16_color_FFFFFF_t_70 1][]

[https_github.com_HelloKittyNII_Knowledge-Library_tree_master_E7_B3_BB_E7_BB_9F_E8_AE_BE_E8_AE_A1]: https://github.com/HelloKittyNII/Knowledge-Library/tree/master/%E7%B3%BB%E7%BB%9F%E8%AE%BE%E8%AE%A1
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA4ODk2MTY_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200117221101166.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA4ODk2MTY=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA4ODk2MTY_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200118221233854.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA4ODk2MTY=,size_16,color_FFFFFF,t_70