开篇

从事Java开发已近一年，随着最近Java开发手册嵩山版的推出，以及阿里云开发者社区关于DDD的讲座（研发效能峰会的相关视频）。使我对编码规范结构规约进行了更深一步技术思考，在理解上和技术落地上有了进一步的提升。
本文主要是基于Java开发手册嵩山版、 代码精进之路——从码农到工匠和我一年的从业经验编写。如有错误请私聊指出，本文会议技术演进和代码迭代的形式，展示我对规范与重构的思考。

起步

我们需要做如下准备

1. Idea 专业版
2. 使用阿里巴巴java脚手架创建一个包含有阿里云SMS服务的Springboot/cloud项目
3. 准备好Java开发手册

代码初步分析

首先我们要对对脚手架生成的SMS服务代码进行分析
由于阿里云代码集成做的比较好 我们主要看控制器那部分

@RestController
public class SmsController {@Autowiredprivate Environment environment;@Autowiredprivate ISmsService smsService;@Autowiredprivate SmsReportMessageListener smsReportMessageListener;@GetMapping("/report-queue.do")public String getSmsReportQueuename() {return environment.getProperty("spring.cloud.alicloud.sms.up-queue-name");}@RequestMapping("/sms-send.do")public SendSmsResponse sendCheckCode(@RequestParam(name = "code") String code) {// 组装请求对象-具体描述见控制台-文档部分内容SendSmsRequest request = new SendSmsRequest();// 必填:待发送手机号request.setPhoneNumbers("******");// 必填:短信签名-可在短信控制台中找到request.setSignName("******");// 必填:短信模板-可在短信控制台中找到request.setTemplateCode("******");// 可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为request.setTemplateParam("{\"code\":\"" + code + "\"}");// 选填-上行短信扩展码(无特殊需求用户请忽略此字段)// request.setSmsUpExtendCode("90997");// 可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者request.setOutId("****TraceId");try {SendSmsResponse sendSmsResponse = smsService.sendSmsRequest(request);return sendSmsResponse;}catch (ClientException e) {e.printStackTrace();}return new SendSmsResponse();}}

从上述代码我们可以看到 有四个为必须填写的选项 手机号 短信签名 和 短信模板还有Code参数中已经包含

    // 必填:待发送手机号request.setPhoneNumbers("******");// 必填:短信签名-可在短信控制台中找到request.setSignName("******");// 必填:短信模板-可在短信控制台中找到request.setTemplateCode("******");   

这时候我们思考一下谁是常量谁是变量 很显然 Code和PhoneNumber是变量而signName和TemplateCode是常量。但是根据业务的不同短信的模板是不可能相同的所以 我们需要一个中间变量来做选择 这样很容易就能改成这样的代码

@RequestMapping("/sms-send.do")public SendSmsResponse sendCheckCode(@RequestParam(name = "code") String code，@RequestParam(name = "phone")  String phoneName，@RequestParam(name = "type")  Integer type) {// 组装请求对象-具体描述见控制台-文档部分内容SendSmsRequest request = new SendSmsRequest();// 必填:待发送手机号request.setPhoneNumbers(phoneName);// 必填:短信签名-可在短信控制台中找到request.setSignName("******");if(type==0){// 必填:短信模板-可在短信控制台中找到request.setTemplateCode("******"); }else ...... // 可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为request.setTemplateParam("{\"code\":\"" + code + "\"}");try {SendSmsResponse sendSmsResponse = smsService.sendSmsRequest(request);return sendSmsResponse;}catch (ClientException e) {e.printStackTrace();}return new SendSmsResponse();}}

这样我们就完成了最基本的代码修改

代码深入分析

在完成基本的功能之后，我们可以基于业务场景进行技术分析。思考该代码除了简单的发送短信之外还需做些什么！
从日常使用可以知道 如下几点

1. 间隔60秒发送
2. 若一定时间内发送的短信过多则冻结一段时间。
3. 可以进行校验
   那我们先对第一个间隔60秒发送进行处理（前后端都需要做处理 我这边展示的是后端的一种方式）

在代码实现中需要使用Redis 其实实现起来很简单 具体代码如下

 if (null==redisService.getCacheObject(phoneNumber+REPEAT_CHECK)){// 组装请求对象-具体描述见控制台-文档部分内容SendSmsRequest request = new SendSmsRequest();// 必填:待发送手机号request.setPhoneNumbers(phoneNumber);// 必填:短信签名-可在短信控制台中找到request.setSignName("闲云");/**type 为 0 为注册模板 1为校验模板*/if (0==type){// 必填:短信模板-可在短信控制台中找到request.setTemplateCode("*****");}else {// 必填:短信模板-可在短信控制台中找到request.setTemplateCode("*****");}// 可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为request.setTemplateParam("{\"code\":\"" + code + "\"}");try {/**设置短信发送间隔时间*/redisService.setCacheObject(phoneNumber+"*****", code, 1, TimeUnit.MINUTES);/**设置短信存活时间*/redisService.setCacheObject(phoneNumber, code, 5, TimeUnit.MINUTES);SendSmsResponse sendSmsResponse = smsService.sendSmsRequest(request);return sendSmsResponse;}catch (ClientException e) {e.printStackTrace();}return new SendSmsResponse();}else {SendSmsResponse sendSmsResponse =new SendSmsResponse();//设置业务编号sendSmsResponse.setBizId("93011");sendSmsResponse.setRequestId("error");sendSmsResponse.setCode("500");sendSmsResponse.setMessage("消息已发送！请勿重复点击 ！ 请60秒后再试！");return sendSmsResponse;}
}

下一个需求其实类似 多一个if/else就可以了。
现在代码实现已经完成了，功能已经可以完整的跑通了，但是从标准行 可读性 可维护性 可扩展性的角度去看这个代码 你会觉得怎样呢！
答案很简单 很烂！

代码重构

现在我们分析一下上面那个代码的问题

1. 代码不规范（通用常量并没有进行申明 采用字符串拼接 缺少中间变量 代码可读性不高）
2. 设计存在缺陷 如 增添 类型和模板的匹配则需要通过If/else 来实现 无法保证代码的可扩展性
3. 对多业务条件拦截的存在问题，代码的扩展性不足。
   上述为该代码的缺陷，下面我将借代码实现讲解处理方式
   因为前面已经讲了代码的具体实现 现在主要讲优化和规范化 这里就不过多说明代码 而是基于我的代码进行讲解

首先说代码规范的问题
在Java开发手册中明确指出 不允许任何魔法值(即未经预先定义的常量)直接出现在代码中
而常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包 内共享常量、类内共享常量。
该模块为短信模块 则我们可以在项目当前目录下创建common包并创建 SmsServiceConstants这个类来管理当前应用下的复用常量

/*** @author mac_zyj* SMS 服务模块常量*/
public class SmsServiceConstants {/*** 注册验证码短信模板*/public static final String REGISTER_MODEL="SMS_198925419";/*** 校验验证码短信模板*/public static final String CHECK_MODEL="SMS_198930412";/*** 短信签名*/public static final String SMS_SIGN_NAME="闲云";/*** 检查一段时间发送次数*/public static final Integer CHECK_SMS_SEND_TIMES_TIME = 1 ;/*** 一段时间内短信发送次数限制*/public static final Integer CHECK_SMS_SEND_TIMES_TIMES_LIMITS = 10;/*** 周期校验后缀*/public static final String TIMES_CHECK="TIMES_CHECK";/*** 周期校验后缀*/public static final String REPEAT_CHECK="CHECK";/*** 验证短信有效期（分钟）*/public static final Integer SMS_USE_EXPIRATION = 5;/*** 验证短信Redis有效期（分钟）*/public static final Integer SMS_REDIS_EXPIRATION = 1;
}

在拥有上述声明之后 则可以通过类名直接调用 ，现在对原有代码进行修改。
为了使代码更加可读 建议使用中间变量+注释的形式。

@Overridepublic SendSmsResponse checkAndSendCheckCode(String code, Integer type, String phoneNumber) {String repeatCheckKey=phoneNumber+ SmsServiceConstants.REPEAT_CHECK;if (null==redisService.getCacheObject(repeatCheckKey)){// 组装请求对象-具体描述见控制台-文档部分内容SendSmsRequest request = new SendSmsRequest();// 必填:待发送手机号request.setPhoneNumbers(phoneNumber);// 必填:短信签名-可在短信控制台中找到request.setSignName("闲云");// 必填:短信模板-可在短信控制台中找到/**type 为 0 为注册模板 1为校验模板*/if (0==type){// 必填:短信模板-可在短信控制台中找到request.setTemplateCode(SmsServiceConstants.REGISTER_MODEL);}else {// 必填:短信模板-可在短信控制台中找到request.setTemplateCode(SmsServiceConstants.CHECK_MODEL);}// 可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为request.setTemplateParam("{\"code\":\"" + code + "\"}");try {/**设置短信发送间隔时间*/redisService.setCacheObject(repeatCheckKey, code, SmsServiceConstants.SMS_REDIS_EXPIRATION, TimeUnit.MINUTES);String timesCheckKey=phoneNumber+ SmsServiceConstants.TIMES_CHECK;Integer redisGetTimes=redisService.getCacheObject(phoneNumber+ SmsServiceConstants.TIMES_CHECK);Integer sendTimesInLastHour= 0;if(null!=redisGetTimes){sendTimesInLastHour=redisGetTimes;}/**设置当前短信发送次数间隔时间*/redisService.setCacheObject(timesCheckKey,++sendTimesInLastHour, SmsServiceConstants.CHECK_SMS_SEND_TIMES_TIME, TimeUnit.HOURS);/**设置短信存活时间*/redisService.setCacheObject(phoneNumber, code, SmsServiceConstants.SMS_USE_EXPIRATION, TimeUnit.MINUTES);SendSmsResponse sendSmsResponse = smsService.sendSmsRequest(request);return sendSmsResponse;}catch (ClientException e) {e.printStackTrace();}return new SendSmsResponse();}else {SendSmsResponse sendSmsResponse =new SendSmsResponse();//设置业务编号sendSmsResponse.setBizId("93011");sendSmsResponse.setRequestId("error");sendSmsResponse.setCode("500");sendSmsResponse.setMessage("消息已发送！请勿重复点击 ！ 请60秒后再试！");return sendSmsResponse;}}

这样清爽了很多了 下面我们对2 3条 问题进行修改
针对第二条这个问题 主要是设计对type的匹配 反观java 类型结构中 有没有适合做这类操作的。很显然就是枚举类型

/*** @author mac_zyj*/
public enum SmsTemplateEnum {/*** 注册验证码短信*/CHECK_MODEL(0,SmsServiceConstants.REGISTER_MODEL),/*** 校验验证码短信*/REGISTER_MODEL(1,SmsServiceConstants.CHECK_MODEL);private Integer type;private String template;SmsTemplateEnum(int type, String template) {this.type = type;this.template = template;}public static String getTemplate(Integer type) {SmsTemplateEnum[] smsTypeEnums = values();for (SmsTemplateEnum smsTypeEnum : smsTypeEnums) {if (smsTypeEnum.type().equals(type)) {return smsTypeEnum.template();}}return null;}private Integer type() {return this.type;}private String template() {return this.template;}
}

在这样的话

            if (0==type){// 必填:短信模板-可在短信控制台中找到request.setTemplateCode(SmsServiceConstants.REGISTER_MODEL);}else {// 必填:短信模板-可在短信控制台中找到request.setTemplateCode(SmsServiceConstants.CHECK_MODEL);}

/**type 为 0 为注册模板 1为校验模板 根据枚举类进行匹配*/request.setTemplateCode(SmsTemplateEnum.getTemplate(type));

在后续添加时 我就不需要对service层的代码进行添加 直接在枚举类型中添加声明即可

下面说一下对第三条的修改
看过代码精进一书的同学，肯定会在书中看到这样一段话

在进行EDM(邮件营销)时要根据一些规则过滤掉一些客户，比如没有邮箱地址的客户、没有订阅关系不能发送邮件的客户、3 天内不能重复发送邮件的客户等。

下面是一个典型的pipeline处理方式，责任链在处理该问题上是一 个很好的选项，FilterChain这个名字非常恰当地表达出了作者的意图， Chain表示用的是责任链模式，Filter表示用来进行过滤。

FilterChain filterChain = FilterChainFactory.buildFilterChain( NoEmailAddressFilter.class,
EmailUnsubscribeFilter.class, EmailThreeDayNotRepeatFilter.class);
//具体的Filter
public class NoEmailAddressFilter implements Filter {
@Override
public void doFilter(Object context, FilterInvoker nextFilter) {
Map<String, Object> contextMap = (Map<String, Object>)context;
String email = ConvertUtils.convertParamType (contextMap. get ("email"), String.class) if(StringUtils.isBlank(email)){
return; }
nextFilter.invoke(context); }
}
参考上述代码 我们可以做如下定义与声明
SmsSendTooMuchFilter
```Java
public class SmsSendTooMuchFilter  implements Filter {private final Logger logger = LoggerFactory.getLogger(SmsSendTooMuchFilter.class);private static final String SMS_ERROR_MESSAGE="短信发送过多，请过后再试!";@Autowiredprivate RedisService redisService;@Overridepublic void doFilter(Object context, FilterInvoker nextFilter) {Map<String,Object> contextMap=(Map<String, Object>) context;String phoneNumber= (String) contextMap.get("phone");Integer sendTimesInLastHour=redisService.getCacheObject(phoneNumber+ SmsServiceConstants.TIMES_CHECK);if(null!=sendTimesInLastHour){if (sendTimesInLastHour>=SmsServiceConstants.CHECK_SMS_SEND_TIMES_TIMES_LIMITS) {SmsException smsException = new SmsException(SmsErrorCode.SMS_SEND_TOO_MUCH_ERROR, SMS_ERROR_MESSAGE);logger.warn("SmsException with error code:{},error message:{}", smsException.getErrCode(), smsException.getMessage());throw smsException;}}nextFilter.invoke(context);}
}

SmsOneMinNotRepeatFilter

/*** @author mac_zyj*  一分钟内不能重复发送短信规则*/
@Configuration
public class SmsOneMinNotRepeatFilter implements Filter {private final Logger logger = LoggerFactory.getLogger(SmsOneMinNotRepeatFilter.class);private static final String SMS_ERROR_MESSAGE="请不要一分钟内重复发送";@Autowiredprivate RedisService redisService;@Overridepublic void doFilter(Object context, FilterInvoker nextFilter){Map<String,Object> contextMap=(Map<String, Object>) context;String phoneNumber= (String) contextMap.get("phone");String repeatCheckKey=phoneNumber+ SmsServiceConstants.REPEAT_CHECK;if(null!=redisService.getCacheObject(repeatCheckKey)){SmsException smsException=new SmsException(SmsErrorCode.SMS_ONE_MIN_NOT_REPEAT_ERROR,SMS_ERROR_MESSAGE);logger.warn("SmsException with error code:{},error message:{}",smsException.getErrCode(),smsException.getMessage());throw smsException;}nextFilter.invoke(context);}
}

/*** 责任链模式工厂* @author shawnzhan.zxy* @date 2018/04/17*/
public class FilterChainFactory {private static ApplicationContext applicationContext= SpringContextUtil.getApplicationContext();public static <T> FilterChain<T> buildFilterChain(Class... filterClsList) {FilterInvoker last = new FilterInvoker() {};FilterChain<T> filterChain = new FilterChain<T>();for (int i = filterClsList.length - 1; i >= 0; i--) {FilterInvoker next = last;Filter filter = (Filter) ApplicationContextHelper.getBean(filterClsList[i]);last = new FilterInvoker<T>() {@Overridepublic void invoke(T context) {filter.doFilter(context, next);}};}filterChain.setHeader(last);return filterChain;}}

这样 代码就修改完毕了
以下为重构之后的代码 是不是简单清晰高效呢。希望大家 也能写出这样高质量、高可读的代码

    /**日志*/private final Logger logger = LoggerFactory.getLogger(ISmsServiceImpl.class);/*** 责任链配置*/private final FilterChain filterChain= FilterChainFactory.buildFilterChain(SmsOneMinNotRepeatFilter.class,SmsSendTooMuchFilter.class);@Autowiredprivate RedisService redisService;@Autowiredprivate ISmsService smsService;
@Overridepublic SendSmsResponse checkAndSendCheckCode(String code, Integer type, String phoneNumber) {String repeatCheckKey=phoneNumber+ SmsServiceConstants.REPEAT_CHECK;Map<String,Object> content=new HashMap<>(16);content.put("phone",phoneNumber);filterChain.doFilter(content);// 组装请求对象-具体描述见控制台-文档部分内容SendSmsRequest request = new SendSmsRequest();// 必填:待发送手机号request.setPhoneNumbers(phoneNumber);// 必填:短信签名-可在短信控制台中找到request.setSignName(SmsServiceConstants.SMS_SIGN_NAME);// 必填:短信模板-可在短信控制台中找到/**type 为 0 为注册模板 1为校验模板 根据枚举类进行匹配*/request.setTemplateCode(SmsTemplateEnum.getTemplate(type));// 可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为request.setTemplateParam("{\"code\":\"" + code + "\"}");try {/**设置短信发送间隔时间*/redisService.setCacheObject(repeatCheckKey, code, SmsServiceConstants.SMS_REDIS_EXPIRATION, TimeUnit.MINUTES);String timesCheckKey=phoneNumber+ SmsServiceConstants.TIMES_CHECK;Integer redisGetTimes=redisService.getCacheObject(phoneNumber+ SmsServiceConstants.TIMES_CHECK);Integer sendTimesInLastHour= 0;if(null!=redisGetTimes){sendTimesInLastHour=redisGetTimes;}/**设置当前短信发送次数间隔时间*/redisService.setCacheObject(timesCheckKey,++sendTimesInLastHour, SmsServiceConstants.CHECK_SMS_SEND_TIMES_TIME, TimeUnit.HOURS);/**设置短信存活时间*/redisService.setCacheObject(phoneNumber, code, SmsServiceConstants.SMS_USE_EXPIRATION, TimeUnit.MINUTES);return smsService.sendSmsRequest(request);} catch (BizException e){logger.warn("BizException with error code:{},error message:{}",e.getErrCode(),e.getMessage());}catch (Exception ex) {logger.error("System error"+ex.getMessage(),ex);}return new SendSmsResponse();}