提高代码复用性的建议

在企业级应用开发中，代码的质量是一个重要的指标，复用性好的代码可以提高开发效率减少不必要的麻烦，也是一种很好的编程习惯，那么有哪些方式可以提升代码的复用性呢？ 本文将会简要分享一些开发经验。

1、微服务的理念：面向接口编程

首先，作为微服务架构下的开发，肯定是有一个面向接口的思维，微服务的理念就是不同的服务组件之间依靠接口通讯，那么接口的好处是什么呢，这一点我相信学习过Java的朋友都会有了解的，接口是实现Java多态的一种方式，一个类可以实现多个接口，所以在开发中接口的利用是提升代码复用性的一个利器，因为接口的应用是很基础的应用了，所以这里不作赘述。

2、常量接口

常量接口就是在一个接口中定义常量，在代码中使用接口加常量名的方式来获取常量值。

例如：项目中多处地方用到“中国”这个字符串，比如是否是中国的判断，如果全在代码中写死，用“中国”.equals来判断，那么如果后期想要把中国换成“中国人民共和国”，那么就需要每个用到这的地方都改，这样的代码质量很低，后期维护也很让人头疼，针对这种情况，我们可以写一个常量接口：

/**
 * 常量接口
 * @author Coder_gasenwell
 * @since 2020/04/15
 */
public interface Constant {
    String CHINA = "中国";
}

然后再方法内具体使用方式： 

import cn.com.ecarx.oms.util.Constant;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
@Transactional
@Service
public class TestServiceImpl implements TestService {
    @Override
    public void testData() {
        if (Constant.CHINA.equals("XX")) {//Constant.CHINA拿到的就是接口中定义的"中国"
            //内容
        }
    }
}

这样一来，如果要把“中国”改成“中华人民共和国”，就只需要改动这个常量接口，代码质量将会提高。

3、枚举类

枚举类跟常量接口有些类似，功能更强大，这里不做过多介绍，直接上代码，一看便知怎么用：

/**
 * 枚举类
 * @author Coder_gasenwell
 * @since 2020/04/15
 */
public class DictEnum {
    public enum Status {//状态枚举
        STATUS_PENDING("0", "待审核"),

        STATUS_EFFECT("1", "生效"),

        STATUS_INVALID("2", "失效");

        private String code;
        private String name;

        Status(String code, String name) {
            this.code = code;
            this.name = name;
        }

        public String getCode() {
            return code;
        }

        public void setCode(String code) {
            this.code = code;
        }

        public String getName() {
            return name;
        }

        public void setName(String name) {
            this.name = name;
        }
    }

}

取值： 

String code = DictEnum.Status.STATUS_PENDING.getCode();
String name = DictEnum.Status.STATUS_PENDING.getName();

 4、引入字典表

从枚举类的代码中我们把一种状态分为了code和name，如果数据库中的许多表都存了状态信息，那么每一张表都要存两个字段：code和name，这样数据库设计将违背第三范式，有过多的冗余字段，这里我们往往会采用维护字典表的方法来解决，我们会把code和name存到相应的字段里，但是如果我们又需要出行方式的字典字段怎么办呢？这样只有code和name怎么能判断是状态的字段还是出行方式的字段？于是我们增加了'type_code'字段作为字段类型，这样就灵活很多了。

mysql建表语句如下：

CREATE TABLE `sys_dict` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '编号',
  `code` varchar(24) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT NULL COMMENT '数据值',
  `name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT NULL COMMENT '标签名',
  `type_code` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT NULL COMMENT '类型编码',
  `type_name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT NULL COMMENT '类型名',
  `sort` int(11) DEFAULT NULL COMMENT '排序（升序）',
  `is_deleted` bit(1) DEFAULT b'0' COMMENT '是否删除',
  `create_by` varchar(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT '' COMMENT '创建人',
  `create_time` datetime DEFAULT NULL COMMENT '创建时间',
  `modified_by` varchar(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT '' COMMENT '更新者',
  `modified_time` datetime DEFAULT NULL COMMENT '更新时间',
  `remarks` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin DEFAULT NULL COMMENT '备注信息',
  PRIMARY KEY (`id`),
  UNIQUE KEY `unique_sys_code_typecode` (`code`,`type_code`),
  KEY `idx_sys_dict_value` (`code`),
  KEY `idx_sys_dict_label` (`name`),
  KEY `idx_sys_dict_del_flag` (`type_code`)
) ENGINE=InnoDB AUTO_INCREMENT=92 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin COMMENT='数据字典表';

字典表的意义其实跟枚举有某些同样的功能，比如统一维度，就是我们说的“中国”改为“中华人民共和国”，使用这些方法会把这些字段的维度统一起来。另外字典表相对于枚举类的优点在于两点：

1：开发可以提供出字典表的增删改操作给系统的管理员用户，这样用户就可以维护这些字段，枚举类只能是开发维护。

2：对于项目中途进入的开发者，字典表有更好的阅读性，更容易理解上手。

3：字典表可以加一个'sort'字段，对同类型的值自动/手动维护一个优先级顺序。

关于字典表我们可以把常用且不常修改的字典信息暂存到Redis里面，这样校验的时候直接从内存中取，避免了数据库层的访问，可以大大提高响应速度，如果是大量信息校验的系统里面，这种写法将会很大限度的提升接口响应速度。

 

以上就是个人在提升代码复用性和代码质量上的一些建议，也算是实践经验吧，感谢阅览，欢迎批评指正。