十次方——父工程子模块、公共模块

一  父工程（project）

首先我们先看下整个项目的一个目录

我们先创建一个带有pom.xml文件的父工程tensquare_parent（即maven工程），

我们可以把tensquare_parent中的src删掉，只留下pom文件，我们来看下pom文件中的parent和dependencies

红色1是我们当前使用spingboot最基础的一个jar包。

红色2是SpringMVC的jar包，有了它springMVC所有的配置都不用写了。

红色3是和junit做整合的jar包。

如果我们在idea中的maven中配置好了jdk1.8，则中间的properties可以不要

比如spring data jpa这些就不需要放到父模块的dependencies中来，因为不是每个模块都需要和数据库作交换。

还有repositories仓库和pluginRepositories插件的配置，一般就按照官网上的配置就行了。

 

然后，我们就可以在父工程tensquare_parent下建立各个子模块（module）就可以了。

 

二  公共模块（tensquare_common）

一般每个项目都会建立一个公共子模块，这里面的内容是在现代java开发中都会用到的：

 

2.1  JavaBean类

我们知道，从前端传到后台的数据都是json数据，所以后台需要将前端传来的json数据转换成JavaBean；后台处理后的JavaBean传到前端之前也需要转换成json。

一个JavaBean想变成json很简单，加个@responseBody注解，而json转换成JavaBean也很简单，加个@RequestBody注解；所以我们只需要创建与json数据相应的JavaBean就可以了。

以十次方为例，所以我们需要创建一个entity包，包里面创建与Json数据对应的JavaBean类。比如下面的返回json对象。

根据上面返回的json对象，我们要创建一个对应的JavaBean类——Result：

package entity;

public class Result {
    private boolean flag;  //是否成功
    private Integer code;   //返回码
    private String message; //返回信息
    private Object data;    //返回数据
    
    // 构造、封装这里省略

}

记住，前台需要的json数据后端都要有与之对应的JavaBean

这种与前后台交互的JavaBean是不需要序列化的，因为他们底层传输是采用的socket的，与序列化之类的无关了；只有在微服务中相互传输的对象才需要序列化，因为只有加了序列化的对象才能在不同平台之间使用IO流进行传输。那有人会说，这个Result对象不是在base模块里也用了吗？确实使用了，但是base模块已经将common模块导入进来了，且后面其他模块都会导入common模块，所以Result这个类只会在各个模块内部用，不存在跨平台传输。

2.2   状态码

上面说的JavaBean类中有个code属性，它就是状态码，学过计算机网络的都知道这是什么，每个公司都有自己的一套状态码，一般标成静态类型：

package entity;

public class StatusCode {
    public static final int OK=20000;//成功
    public static final int ERROR =20001;//失败
    public static final int LOGINERROR =20002;//用户名或密码错误
    public static final int ACCESSERROR =20003;//权限不足
    public static final int REMOTEERROR =20004;//远程调用失败
    public static final int REPERROR =20005;//重复操作
    
    // 实际公司中可能有几百甚至几千
}

 

2.3   分布式Id生成器

因为我们现在采用的是微服务架构，可能一个微服务中的多个容器在同一时刻往同一张表中插数据，甚至是不同微服务操作同一张表，所以要确保此时生成的Id不一样。

十次方项目采用的是类snowflake方案：

这种方案生成一个64bit的数字，64bit被划分成多个段，分别表示时间戳、机器编码、序号。 

ID为64bit 的long 数字，由三部分组成：

• 41位的时间序列(精确到毫秒，41位的长度可以使用69年)。
• 10位的机器标识(10位的长度最多支持部署1024个节点)。
• 12位的计数顺序号(12位的计数顺序号支持每个节点每毫秒产生4096个ID序号)。

经过测试，SnowFlake每秒能够产生26万Id左右，如果超过了，那就只能通过消息队列来解决了。代码如下

package util;

import java.lang.management.ManagementFactory;
import java.net.InetAddress;
import java.net.NetworkInterface;

/**
 * <p>名称：IdWorker.java</p>
 * <p>描述：分布式自增长ID</p>
 * <pre>
 *     Twitter的 Snowflake　JAVA实现方案
 * </pre>
 * 核心代码为其IdWorker这个类实现，其原理结构如下，我分别用一个0表示一位，用—分割开部分的作用：
 * 1||0---0000000000 0000000000 0000000000 0000000000 0 --- 00000 ---00000 ---000000000000
 * 在上面的字符串中，第一位为未使用（实际上也可作为long的符号位），接下来的41位为毫秒级时间，
 * 然后5位datacenter标识位，5位机器ID（并不算标识符，实际是为线程标识），
 * 然后12位该毫秒内的当前毫秒内的计数，加起来刚好64位，为一个Long型。
 * 这样的好处是，整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞（由datacenter和机器ID作区分），
 * 并且效率较高，经测试，snowflake每秒能够产生26万ID左右，完全满足需要。
 * <p>
 * 64位ID (42(毫秒)+5(机器ID)+5(业务编码)+12(重复累加))
 *
 * @author Polim
 */
public class IdWorker {
    // 时间起始标记点，作为基准，一般取系统的最近时间（一旦确定不能变动）
    private final static long twepoch = 1288834974657L;
    // 机器标识位数
    private final static long workerIdBits = 5L;
    // 数据中心标识位数
    private final static long datacenterIdBits = 5L;
    // 机器ID最大值
    private final static long maxWorkerId = -1L ^ (-1L << workerIdBits);
    // 数据中心ID最大值
    private final static long maxDatacenterId = -1L ^ (-1L << datacenterIdBits);
    // 毫秒内自增位
    private final static long sequenceBits = 12L;
    // 机器ID偏左移12位
    private final static long workerIdShift = sequenceBits;
    // 数据中心ID左移17位
    private final static long datacenterIdShift = sequenceBits + workerIdBits;
    // 时间毫秒左移22位
    private final static long timestampLeftShift = sequenceBits + workerIdBits + datacenterIdBits;

    private final static long sequenceMask = -1L ^ (-1L << sequenceBits);
    /* 上次生产id时间戳 */
    private static long lastTimestamp = -1L;
    // 0，并发控制
    private long sequence = 0L;

    private final long workerId;
    // 数据标识id部分
    private final long datacenterId;

    public IdWorker(){
        this.datacenterId = getDatacenterId(maxDatacenterId);
        this.workerId = getMaxWorkerId(datacenterId, maxWorkerId);
    }
    /**
     * @param workerId
     *            工作机器ID
     * @param datacenterId
     *            序列号
     */
    public IdWorker(long workerId, long datacenterId) {
        if (workerId > maxWorkerId || workerId < 0) {
            throw new IllegalArgumentException(String.format("worker Id can't be greater than %d or less than 0", maxWorkerId));
        }
        if (datacenterId > maxDatacenterId || datacenterId < 0) {
            throw new IllegalArgumentException(String.format("datacenter Id can't be greater than %d or less than 0", maxDatacenterId));
        }
        this.workerId = workerId;
        this.datacenterId = datacenterId;
    }
    /**
     * 获取下一个ID
     *
     * @return
     */
    public synchronized long nextId() {
        long timestamp = timeGen();
        if (timestamp < lastTimestamp) {
            throw new RuntimeException(String.format("Clock moved backwards.  Refusing to generate id for %d milliseconds", lastTimestamp - timestamp));
        }

        if (lastTimestamp == timestamp) {
            // 当前毫秒内，则+1
            sequence = (sequence + 1) & sequenceMask;
            if (sequence == 0) {
                // 当前毫秒内计数满了，则等待下一秒
                timestamp = tilNextMillis(lastTimestamp);
            }
        } else {
            sequence = 0L;
        }
        lastTimestamp = timestamp;
        // ID偏移组合生成最终的ID，并返回ID
        long nextId = ((timestamp - twepoch) << timestampLeftShift)
                | (datacenterId << datacenterIdShift)
                | (workerId << workerIdShift) | sequence;

        return nextId;
    }

    private long tilNextMillis(final long lastTimestamp) {
        long timestamp = this.timeGen();
        while (timestamp <= lastTimestamp) {
            timestamp = this.timeGen();
        }
        return timestamp;
    }

    private long timeGen() {
        return System.currentTimeMillis();
    }

    /**
     * <p>
     * 获取 maxWorkerId
     * </p>
     */
    protected static long getMaxWorkerId(long datacenterId, long maxWorkerId) {
        StringBuffer mpid = new StringBuffer();
        mpid.append(datacenterId);
        String name = ManagementFactory.getRuntimeMXBean().getName();
        if (!name.isEmpty()) {
            /*
             * GET jvmPid
             */
            mpid.append(name.split("@")[0]);
        }
        /*
         * MAC + PID 的 hashcode 获取16个低位
         */
        return (mpid.toString().hashCode() & 0xffff) % (maxWorkerId + 1);
    }

    /**
     * <p>
     * 数据标识id部分
     * </p>
     */
    protected static long getDatacenterId(long maxDatacenterId) {
        long id = 0L;
        try {
            InetAddress ip = InetAddress.getLocalHost();
            NetworkInterface network = NetworkInterface.getByInetAddress(ip);
            if (network == null) {
                id = 1L;
            } else {
                byte[] mac = network.getHardwareAddress();
                id = ((0x000000FF & (long) mac[mac.length - 1])
                        | (0x0000FF00 & (((long) mac[mac.length - 2]) << 8))) >> 6;
                id = id % (maxDatacenterId + 1);
            }
        } catch (Exception e) {
            System.out.println(" getDatacenterId: " + e.getMessage());
        }
        return id;
    }


}

 

现在我们在另一子模块tenquare_base中有业务需要进行增删改查，这时在这个模块里就需要调用tenquare_base中的这段分布式Id生成器的代码，其实很简单，就两步：

1.在tenquare_base的pom文件中导入tensquare_common的jar包，这样你才能调用tenquare_base模块中的类与方法。

2.引入jar包后还不行，此时的生成器并没在这个模块的spring容器中。我们可以直接在tensquare_common中的IdWorker类上加注解加入容器，但是并不是其他所有模块都需要，所以我们采用谁用谁往容器中放：

因为现在我们tensquare_base模块需要，所以我们在此模块中通过@Bean标签把id生成器放进去：

这样，通过@Bean注解，上图圈中方法的IdWorker类型的返回值就在容器中了。

 

2.4  异常处理

我们在controller里写个异常：

个异

如果我们不对异常进行处理，则调用这个接口的时候就会返回如下数据

根据2.3节所讲的，这显然不是前端需要的数据，所以我们应该对异常进行处理。我们在controller层写上一个异常处理类BaseExceptionHandler：

package com.tensquare.base.controller;

//import部分这里省略

@RestControllerAdvice
public class BaseExceptionHandler {

    @ExceptionHandler(value=Exception.class)
    public Result exception(Exception e){
        e.printStackTrace();
        return new Result(false, StatusCode.ERROR, e.getMessage());
    }
}

这样，返回的数据就是前端所需要的数据格式了