编码技巧——基于Socket通信的接口调用

背景

在新公司项目开发，发现内部服务之间竟然有基于Socket通信的"上古"接口，它甚至都不是Http，难找到一些类似Apache的工具包提供好用的操作api，所以需要自己实现；以下是代码示例；

代码

（1）配置property文件

sms_config.properties

# 短信发送相关配置
# 接口鉴权账号
sms.account=62340C4CC23F46C0915E492E39473492
# 接口鉴权token
sms.token=915e46a0cdff4f33824ce69e7b8056b4
# socket参数
sms.socket.maxMsgPackLength=2048
sms.socket.socTimeOut=500
sms.socket.connect.timeOut=1000
# 编码集
sms.socket.encoding=GBK
# 发送文本格式
sms.sendStr.format=%08d
# 短信接口地址端口 测试用localhost启动server来mock
sms.socket.serverIP=127.0.0.1
sms.socket.serverPort=29999

（2）Socket Server服务mock

/**
 * mock socket server
 */
public class TestSms {

    @Test
    public void testServer() {
        // 启动socketServer
        ExecutorService executorService = Executors.newFixedThreadPool(3);
        try {
            // 初始化
            ServerSocket serverSocket = new ServerSocket(29999);
            System.out.println("socket server 启动成功!");
            //noinspection InfiniteLoopStatement
            while (true) {
                Socket accept = serverSocket.accept();
                System.out.println(accept.getInetAddress().getHostAddress());
                executorService.execute((new CustomRunnable(accept)));
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 用来处理客户端请求的线程
     */
    class CustomRunnable implements Runnable {
        private Socket socket;

        public CustomRunnable(Socket socket) {
            this.socket = socket;
        }

        @Override
        public void run() {
            try {
                byte[] buffer = new byte[2048];
                InputStream is = socket.getInputStream();
                is.read(buffer, 0, buffer.length);
                String gbkStr = new String(buffer, "GBK");
                System.out.println("接收到client " + socket.getInetAddress() + " port " + socket.getPort() + " msg:" + gbkStr);
                socket.shutdownInput();

                OutputStream outputStream = socket.getOutputStream();
                String respStr = JSON.toJSONString(FacadeDefaultDTO.success(null));
                String respEncode = String.format("%08d", respStr.getBytes("GBK").length) + respStr;
                byte[] gbks = respEncode.getBytes("GBK");
                outputStream.write(gbks, 0, gbks.length);
//                socket.shutdownOutput();

            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

（3）调用方示例

/**
 * 基于socket的短信服务
 */
@Slf4j
@Service
@PropertySource({"classpath:META-INF/sms_config.properties"})
public class SmsServiceImpl implements SmsService {

    @Value("${sms.account}")
    private String smsAccount;
    @Value("${sms.token}")
    private String smsToken;
    @Value("${sms.socket.maxMsgPackLength}")
    private int maxMsgPackLength;
    @Value("${sms.socket.encoding}")
    private String encoding;
    @Value("${sms.socket.serverIP}")
    private String serverIP;
    @Value("${sms.socket.serverPort}")
    private int serverPort;
    @Value("${sms.socket.socTimeOut}")
    private int socTimeOut;
    @Value("${sms.socket.connect.timeOut}")
    private int connTimeout;
    @Value("${sms.sendStr.format}")
    private String sendStrFormat;

    /**
     * 向指定手机号发送微信消息
     *
     * @param phoneNumber
     * @param content
     * @return
     */
    @Override
    public boolean sendWechatSms(String phoneNumber, String content) {
        String sendNo = generateSendNo(phoneNumber, content, LocalDateTime.now());
        return sendWechatSms(phoneNumber, content, sendNo);
    }

    /**
     * 生成发送流水号 用于幂等或疲劳度控制
     *
     * @param mobile
     * @param content
     * @param now
     * @return
     */
    @Override
    public String generateSendNo(String mobile, String content, LocalDateTime now) {
        String md5short = MD5Utils.encode32(content).substring(0, Math.min(content.length(), 5));
        String minuteTime = DateUtils.date2String(DateUtils.getNowAccurate2minute(now), DateUtils.DATE_FORMAT_7);
        return String.join(CacheKeyUtils.SEPARATOR, mobile, minuteTime, md5short);
    }

    /**
     * 向指定手机号发送微信消息
     *
     * @param phoneNumber
     * @param content
     * @param sendNo      可用于幂等
     * @return
     */
    @Override
    public boolean sendWechatSms(String phoneNumber, String content, String sendNo) {
        Map paramsMap = Maps.newLinkedHashMap();
        paramsMap.put("account", smsAccount);
        paramsMap.put("token", smsToken);
        paramsMap.put("mobile", phoneNumber);
        paramsMap.put("tempid", sendNo);
        paramsMap.put("content", content);
        String reqStr = JSON.toJSONString(paramsMap);
        log.info("smsService#send. [req={}]", reqStr);
        String respStr = sendBySocket(reqStr);
        if (StringUtils.isBlank(respStr)) {
            log.error("发送微信短信失败 Socket请求返回为null! [req={} resp={}]", reqStr, respStr);
            return false;
        }
        FacadeDefaultDTO