ID 的生成, 返回 JSON 等工具公共类

最新推荐文章于 2023-10-08 09:57:37 发布

YKenan

最新推荐文章于 2023-10-08 09:57:37 发布

阅读量588

点赞数 1

分类专栏： Java SpringBoot/Cloud 开发文章标签： java json 算法

本文链接：https://blog.csdn.net/YKenan/article/details/106319712

版权

Java SpringBoot/Cloud 开发专栏收录该内容

48 篇文章 1 订阅

订阅专栏

雪花算法,返回 JSON 工具公共类等

1. 简介

做 Spring Cloud + Vue 前后端分离技术中, 后端需要返回 JSON 数据, 这是需要工具类, 抛出异常也需要工具类, ID 的生成也需要工具类.

2. ID 的生成

这里用 雪花算法

2.1 工具类

package com.portal.common.util;

import lombok.Data;

/**
 * Snowflake algorithm, an open-source distributed ID generation algorithm of Twitter.
 *
 * @author Administrator
 */
@Data
public class IdWorker {

    /* Because the first bit in binary is negative if it is 1, but the IDS we generate are all positive, so the first bit is 0. */

    /**
     * 机器 ID 2进制5位  32位减掉1位 31个
     */
    private long workerId;
    /**
     * 机房ID 2进制5位  32位减掉1位 31个
     */
    private long dataCenterId;
    /**
     * 代表一毫秒内生成的多个id的最新序号  12位 4096 -1 = 4095 个
     */
    private long sequence;
    /**
     * 设置一个时间初始值 2^41 - 1 差不多可以用 69 年
     */
    private long timeInit = 1585644268888L;
    /**
     * 5位的机器id
     */
    private long workerIdBits = 5L;
    /**
     * 5位的机房id
     */
    private long dataCenterIdBits = 5L;
    /**
     * 每毫秒内产生的id数 2 的 12次方
     */
    private long sequenceBits = 12L;
    /**
     * 这个是二进制运算，就是5 bit最多只能有31个数字，也就是说机器id最多只能是32以内
     */
    private long maxWorkerId = ~(-1L << workerIdBits);
    /**
     * 这个是一个意思，就是5 bit最多只能有31个数字，机房id最多只能是32以内
     */
    private long maxDataCenterId = ~(-1L << dataCenterIdBits);

    private long workerIdShift = sequenceBits;
    private long dataCenterIdShift = sequenceBits + workerIdBits;
    private long timestampLeftShift = sequenceBits + workerIdBits + dataCenterIdBits;
    private long sequenceMask = ~(-1L << sequenceBits);
    /**
     * 记录产生时间毫秒数，判断是否是同 1 毫秒
     */
    private long lastTimestamp = -1L;

    public IdWorker(long workerId, long dataCenterId, long sequence) {
        // 检查机房 id 和机器 id 是否超过 31 不能小于 0
        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;
        this.sequence = sequence;
    }

    /**
     * 这个是核心方法，通过调用 nextId() 方法，让当前这台机器上的 snowflake 算法程序生成一个全局唯一的 id
     *
     * @return long
     */
    public synchronized long nextId() {
        // 这儿就是获取当前时间戳，单位是毫秒
        long timestamp = timeGen();
        if (timestamp < lastTimestamp) {
            System.err.printf("clock is moving backwards. Rejecting requests until %d.", lastTimestamp);
            throw new RuntimeException(
                    String.format("Clock moved backwards. Refusing to generate id for %d milliseconds", lastTimestamp - timestamp)
            );
        }

        // 下面是说假设在同一个毫秒内，又发送了一个请求生成一个 id
        // 这个时候就得把 sequence 序号给递增 1，最多就是 4096
        if (lastTimestamp == timestamp) {
            // 这个意思是说一个毫秒内最多只能有 4096 个数字，无论你传递多少进来，
            // 这个位运算保证始终就是在 4096 这个范围内，避免你自己传递个 sequence 超过了 4096 这个范围
            sequence = (sequence + 1) & sequenceMask;
            // 当某一毫秒的时间，产生的 id 数 超过 4095，系统会进入等待，直到下一毫秒，系统继续产生 ID
            if (sequence == 0) {
                timestamp = tilNextMillis(lastTimestamp);
            }
        } else {
            sequence = 0;
        }
        // 这儿记录一下最近一次生成 id 的时间戳，单位是毫秒
        lastTimestamp = timestamp;
        // 这儿就是最核心的二进制位运算操作，生成一个 64bit 的 id
        // 先将当前时间戳左移，放到 41 bit 那儿；将机房 id 左移放到 5 bit 那儿；将机器 id 左移放到 5 bit 那儿；将序号放最后 12 bit
        // 最后拼接起来成一个 64 bit 的二进制数字，转换成 10 进制就是个 long 型
        return ((timestamp - timeInit) << timestampLeftShift) |
                (dataCenterId << dataCenterIdShift) |
                (workerId << workerIdShift) | sequence;
    }

    /**
     * 当某一毫秒的时间，产生的 id 数 超过 4095，系统会进入等待，直到下一毫秒，系统继续产生 ID
     *
     * @param lastTimestamp lastTimestamp
     * @return long
     */
    private long tilNextMillis(long lastTimestamp) {
        long timestamp = timeGen();
        while (timestamp <= lastTimestamp) {
            timestamp = timeGen();
        }
        return timestamp;
    }

    /**
     * 获取当前时间戳
     *
     * @return long
     */
    private long timeGen() {
        return System.currentTimeMillis();
    }

}

2.2 使用

package com.springCloud.user.config.idWoker;

import com.springCloud.common.util.IdWorker;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class UserIdWorker {

    @Bean
    public IdWorker idWorker() {
        return new IdWorker(1, 1, 1);
    }


}


	......
    // 创建 IdWorker 对象 idWorker.
    private IdWorker idWorker;
	......

    /**
     * 必须有构造函数
     */
    public UserServiceImpl() {
    }

    /**
     * 获取容器对象
     *
     * @param userDao  识别 userDao 容器对象
     * @param idWorker 识别 idWorker 容器对象
     */
    @Autowired
    private UserServiceImpl(......
							IdWorker idWorker
							......) {
		......
        this.idWorker = idWorker;
		......
    }
	......
        // 随机生成 id 号 (雪花算法)
        String id = String.valueOf(idWorker.nextId());
	......

3. 返回类

返回的工具类

package com.ykenan.monitor.util;

import java.io.Serializable;

/**
 * 返回的类型
 *
 * @param <T>
 */
public class Result<T> implements Serializable {

    private Integer code;
    private boolean flag;
    private String message;
    private T data;

    public Result() {
    }

    public Result(Integer code, boolean flag, String message) {
        this.code = code;
        this.flag = flag;
        this.message = message;
    }

    public Result(Integer code, boolean flag, String message, T data) {
        this.code = code;
        this.flag = flag;
        this.message = message;
        this.data = data;
    }

    public Integer getCode() {
        return code;
    }

    public boolean isFlag() {
        return flag;
    }

    public String getMessage() {
        return message;
    }

    public T getData() {
        return data;
    }

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

    public void setFlag(boolean flag) {
        this.flag = flag;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public void setData(T data) {
        this.data = data;
    }

    @Override
    public String toString() {
        return "Result{" +
                "code=" + code +
                ", flag=" + flag +
                ", message='" + message + '\'' +
                ", data=" + data +
                '}';
    }
}

分页的工具类

package com.ykenan.monitor.util;

import java.io.Serializable;
import java.util.List;

/**
 * 换回分页数据的信息:
 * PageResult<T> 返回类型
 * total: 数据的总数.
 * pageSize: 分页的页数.
 * data: 当前分页的数据.
 * @param <T>
 */

public class PageResult<T> implements Serializable {

    private long total;
    private Integer pageSize;
    private List<T> data;

    public long getTotal() {
        return total;
    }

    public void setTotal(long total) {
        this.total = total;
    }

    public Integer getPageSize() {
        return pageSize;
    }

    public void setPageSize(Integer pageSize) {
        this.pageSize = pageSize;
    }

    public List<T> getData() {
        return data;
    }

    public void setData(List<T> data) {
        this.data = data;
    }

    public PageResult(long total, Integer pageSize, List<T> data) {
        this.total = total;
        this.pageSize = pageSize;
        this.data = data;
    }

    @Override
    public String toString() {
        return "PageResult{" +
                "total=" + total +
                ", pageSize=" + pageSize +
                ", data=" + data +
                '}';
    }
}

自定义状态码

package com.ykenan.monitor.util;

import java.io.Serializable;

/**
 * 返回请求状态
 */
public enum StatusCode implements Serializable {

    OK(20000, "成功"),
    ERROR(20001, "失败"),
    LOGIN_ERROR(20002, "用户名或密码错误"),
    ACCESS_ERROR(20003, "权限不足"),
    REMOTE_ERROR(20004, "远程调用失败"),
    REP_ERROR(20005, "重复操作");

    private int code;
    private String content;

    StatusCode(int code, String content) {
        this.code = code;
        this.content = content;
    }

    public int getCode() {
        return code;
    }

    public String getContent() {
        return content;
    }
}

使用

return new Result(StatusCode.OK.getCode(), true, "查询成功", userService.findById(id));

4. 异常

package com.ykenan.monitor.config.error;

import com.ykenan.monitor.util.Result;
import com.ykenan.monitor.util.StatusCode;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

/**
 * 全局异常处理
 */
@RestControllerAdvice
public class Exception {

    @ExceptionHandler(java.lang.Exception.class)
    public Result<String> exception(java.lang.Exception e) {
        return new Result<>(StatusCode.ERROR.getCode(), false, "请求发生错误, 请重试", e.getMessage());
    }

}

捕获 404 异常需要加上下面的配置

spring:
  mvc:
    throw-exception-if-no-handler-found: true
  resources:
    add-mappings: false

5. 得到 Spring 容器中的 Bean

5.1 工具类

package com.springCloud.common.util;

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.lang.Nullable;

/**
 * 获取 Spring 中 bean
 */
public class SpringUtil implements ApplicationContextAware {

    private static ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(@Nullable ApplicationContext applicationContext) throws BeansException {
        if (SpringUtil.applicationContext == null) {
            SpringUtil.applicationContext = applicationContext;
        }
        System.out.println("========ApplicationContext 配置成功,在普通类可以通过调用 SpringUtil.getAppContext() 获取 applicationContext 对象, applicationContext=" + SpringUtil.applicationContext + "========");
    }

    // 获取 applicationContext
    private static ApplicationContext getApplicationContext() {
        return applicationContext;
    }

    // 通过 name 获取 Bean.
    public static Object getBean(String name) {
        return getApplicationContext().getBean(name);
    }

    // 通过 class 获取 Bean.
    public static <T> T getBean(Class<T> clazz) {
        return getApplicationContext().getBean(clazz);
    }

    // 通过 name, 以及 Class 返回指定的 Bean
    public static <T> T getBean(String name, Class<T> clazz) {
        return getApplicationContext().getBean(name, clazz);
    }

}

5.2 使用

使用过程和 ID 的生成的一样, 需要将该类加入 Bean.

6. JSON 与 POJO 类对象之间的转化

package com.commerce.common.util;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.ObjectMapper;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * 自定义响应结构, 转换类
 */
public class JsonUtil {

    // 定义 jackson 对象
    private static final ObjectMapper MAPPER = new ObjectMapper();

    /**
     * 将对象转换成json字符串。
     * <p>Title: pojoToJson</p>
     * <p>Description: </p>
     *
     * @param data data
     * @return String
     */
    public static String objectToJson(Object data) {
        try {
            return MAPPER.writeValueAsString(data);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * @param jsonData json数据
     * @param beanType 对象中的 object 类型
     * @param <T>      T
     * @return <T>
     */
    public static <T> T jsonToPojo(String jsonData, Class<T> beanType) {
        try {
            return MAPPER.readValue(jsonData, beanType);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * 将 json 数据转换成 pojo 对象 list
     * <p>Title: jsonToList</p>
     * <p>Description: </p>
     *
     * @param jsonData json数据
     * @param beanType 对象中的 object 类型
     * @return <T>List<T>
     */
    public static <T> List<T> jsonToList(String jsonData, Class<T> beanType) {
        JavaType javaType = MAPPER.getTypeFactory().constructParametricType(List.class, beanType);
        try {
            return MAPPER.readValue(jsonData, javaType);
        } catch (Exception e) {
            e.printStackTrace();
        }

        return null;
    }

    /**
     * 将 json 数据转换成 Map 对象
     * <p>Title: jsonToMap</p>
     * <p>Description: </p>
     *
     * @param jsonData json数据
     * @param mapKey 对象中的 Key 类型
     * @param mapValue 对象中的 Value 类型
     * @return <T>List<T>
     */
    public static <K, V> Map<K, V> jsonToMap(String jsonData, Class<K> mapKey, Class<V> mapValue) {
        String json = jsonData.replaceAll("'", "\"");
        JavaType javaType = MAPPER.getTypeFactory().constructParametricType(HashMap.class, mapKey, mapValue);
        try {
            return MAPPER.readValue(json, javaType);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

}

7. 判断系统 Windows Linux

package com.ykenan.monitor.util;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * 判断系统, Windows Linux
 */
public class JudgeSystem {

    private static final Logger log = LoggerFactory.getLogger(JudgeSystem.class);

    private static boolean isLinux() {
        return System.getProperty("os.name").toLowerCase().contains("linux");
    }

    private static boolean isWindows() {
        return System.getProperty("os.name").toLowerCase().contains("windows");
    }

    public static String judgeSystem() {
        if (isLinux()) {
            log.info(System.getProperty("os.name") + " >>>> 支持");
            return "linux";
        } else if (isWindows()) {
            log.info(System.getProperty("os.name") + " >>>> 支持");
            return "windows";
        } else {
            log.error(System.getProperty("os.name") + " >>>> 不支持, 只支持 Windows 和 Linux, 可能存在着不知名的错误.");
            return "other system";
        }
    }
}

7.1 用于判断网络连通状况

依赖三个知识点:

JudgeSystem: 判断系统
ExecCmd: 执行 CMD 命令 https://blog.csdn.net/YKenan/article/details/110919068
ExecLinux: 执行 Linux 命令 https://blog.csdn.net/YKenan/article/details/88713506

package com.ykenan.monitor.util;

import com.ykenan.monitor.util_self.StatusNet;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.util.List;

/**
 * 判断网路是否链接成功
 */
@Component
public class NetConnection {

    private static final Logger log = LoggerFactory.getLogger(NetConnection.class);

    private ExecLinux execLinux;

    public NetConnection() {
    }

    @Autowired
    private NetConnection(ExecLinux execLinux) {
        this.execLinux = execLinux;
    }

    /**
     * Windows 下的连接状况
     *
     * @param ip IP 地址
     * @return 状态码
     */
    public static int windows(String ip) {
        Process p;
        BufferedReader in = null;
        try {
            // 此处 1 变大可以增加精确度, 但影响测试速度
            p = Runtime.getRuntime().exec("cmd /c ping -n 1 " + ip);
            // 缓冲读取
            in = new BufferedReader(new InputStreamReader(p.getInputStream(), "gbk"));
            String temp;
            StringBuilder stringBuilder = new StringBuilder();
            while ((temp = (in.readLine())) != null)
                stringBuilder.append(temp);
            if (stringBuilder.toString().contains("请求超时")) {
                log.info("Windows " + ip + " 请求超时");
                return StatusNet.TIMEOUT.getCode();
            } else if (stringBuilder.toString().contains("传输失败")) {
                log.info("Windows " + ip + " 传输失败");
                return StatusNet.FAILURE.getCode();
            } else if (stringBuilder.toString().contains("请求找不到主机")) {
                log.info("Windows " + ip + " 请求找不到主机");
                return StatusNet.UNREACHABLE.getCode();
            } else if (stringBuilder.toString().contains("TTL")) {
                log.info("Windows " + ip + " 监测网络连接正常");
                return StatusNet.OK.getCode();
            } else {
                log.info("Windows " + ip + " 监测网络未知异常");
                return StatusNet.UNKNOWN.getCode();
            }
        } catch (IOException e) {
            log.info("Windows 网络连接出现错误");
            return StatusNet.CONNECT_ERROR.getCode();
        } finally {
            try {
                if (in != null) {
                    in.close();
                }
            } catch (IOException e) {
                log.info("IOException 关闭文件流");
            }
        }
    }

    /**
     * Linux 下的连接状况
     *
     * @param ip IP 地址
     * @return 状态码
     */
    public int linux(String ip) {
        try {
            // 此处 1 变大可以增加精确度, 但影响测试速度
            List<String> execCommand = execLinux.getExecCommand(execLinux, "ping -c 1 " + ip);
            StringBuilder stringBuilder = new StringBuilder();
            for (String content : execCommand) {
                stringBuilder.append(content);
            }
            if (stringBuilder.toString().toLowerCase().contains("request time out")) {
                log.info("Linux " + ip + " 请求超时");
                return StatusNet.TIMEOUT.getCode();
            } else if (stringBuilder.toString().toLowerCase().contains("general failure")) {
                log.info("Linux " + ip + " 传输失败");
                return StatusNet.FAILURE.getCode();
            } else if (stringBuilder.toString().toLowerCase().contains("host unreachable")) {
                log.info("Linux " + ip + " 请求找不到主机");
                return StatusNet.UNREACHABLE.getCode();
            } else if (stringBuilder.toString().toLowerCase().contains("ttl")) {
                log.info("Linux " + ip + " 监测网络连接正常");
                return StatusNet.OK.getCode();
            } else {
                log.info("Linux " + ip + " 监测网络未知异常");
                return StatusNet.UNKNOWN.getCode();
            }
        } catch (IOException e) {
            log.error("Linux 网络连接出现错误");
            return StatusNet.CONNECT_ERROR.getCode();
        }
    }


    /**
     * 得到连接状况
     *
     * @param ip IP 地址
     * @return 状态码
     */
    public int judge(String ip) {
        if ("windows".equals(JudgeSystem.judgeSystem())) {
            log.info("windows >>>> ping -n 1 " + ip);
            return windows(ip);
        } else if ("linux".equals(JudgeSystem.judgeSystem())) {
            log.info("linux >>>> ping -c 1 " + ip);
            return linux(ip);
        } else {
            log.error("未支持系统进行操作");
            return StatusNet.NO_SUPPORT.getCode();
        }
    }

}