统一API响应结果封装

Java中接口返回结果只需要一种封装就够，就是数据返回json格式，或者对象格式，其中，接口返回中包含状态码，返回状态信息，和数据信息。其他的不需要写太多花里胡哨的东西。

API接口返回数据封装

import java.io.Serializable;
 
public class ResponseData<T> implements Serializable {

    /**
	 * 
	 */
	private static final long serialVersionUID = 7098362967623367826L;

	/**
     * 响应状态码
     */
    private Integer code;

    /**
     * 响应信息
     */
    private String message;

    /**
     * 响应对象
     */
    private T data;

    /** 是否加密返回参数*/
    private boolean encrypt;

    public Integer getCode() {
        return code;
    }

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

    public String getMessage() {
        return message;
    }

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


    public T getData() {
        return data;
    }

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

    public static <T> ResponseData<T> success() {
        return success(ResponseCode.SUCCESS);
    }

    public static <T> ResponseData<T> success(ResponseCode code) {
        return success(code, null);
    }

    public static <T> ResponseData<T> success(T object) {
        return success(ResponseCode.SUCCESS, object);
    }

    public static <T> ResponseData<T> success(ResponseCode code, T object) {
        return success(code.getCode(), code.getMessage(), object);
    }

    public static <T> ResponseData<T> success(Integer code, String message, T data) {
        ResponseData<T> response = new ResponseData<>();
        response.setCode(code);
        response.setMessage(message);
        response.setData(data);
        return response;
    }

    public static <T> ResponseData<T> error() {
        return error(ResponseCode.FAILED);
    }

    public static <T> ResponseData<T> error(ResponseCode code) {
        return error(code, null);
    }

    public static <T> ResponseData<T> error(String message) {
        return error(ResponseCode.FAILED.getCode(), message, null);
    }

    public static <T> ResponseData<T> error(Integer code, String message) {
        return error(code, message, null);
    }

    public static <T> ResponseData<T> error(ResponseCode code, T data) {
        return error(code.getCode(), code.getMessage(), data);
    }

    public static <T> ResponseData<T> error(Integer code, String message, T data) {
        ResponseData<T> response = new ResponseData<>();
        response.setCode(code);
        response.setMessage(message);
        response.setData(data);
        return response;
    }


    public boolean isEncrypt() {
        return encrypt;
    }

    public void setEncrypt(boolean encrypt) {
        this.encrypt = encrypt;
    }
}

在controller中的使用

	/**
	 * 查询所有小程序配置字典列表
	 * @param  
	 * @return
	 */
	@ApiOperation(value = "查询所有小程序配置字典列表", notes = "查询所有小程序配置字典列表")
    @PostMapping("searchAll")
    public ResponseData<List<MAppConf>> searchAll() {
		List<MAppConf> mAppConfList = mAppConfService.searchAll();
    	if(!CtgUtils.isCollectionNull(mAppConfList)) {
        	return  ResponseData.success(mAppConfList);
    	}else {
    		log.info(MAppConfConstant.NOT_EXIST);
    		return  ResponseData.success(mAppConfList);
    	}
    }

使用原理

主要使用到了Java中的泛型。

1. 定义

泛型，即“参数化类型”，是一种将类型作为参数传递给类、接口或方法的技术。通过泛型，可以在编译时期检查数据类型的合法性，从而避免运行时类型转换错误，提高了程序的稳定性和安全性。

2. 好处

• 类型安全：在编译时期就能检查到类型错误，而不是在运行时。
• 消除强制类型转换：泛型提供了编译时期的类型检查，因此在大多数情况下，不需要进行强制类型转换。
• 提高代码重用性：可以编写更加通用的代码，如集合类（List、Set、Map）等，适用于各种数据类型。

在泛型中，常见的字母表示法用于表示类型参数，它们没有固定含义，但在惯例中被广泛使用：

• T：表示任意类型（Type）。
• E：表示元素（Element），通常用于表示集合中的元素类型。
• K：表示键（Key），通常用于表示键值对中的键的类型。
• V：表示值（Value），通常用于表示键值对中的值的类型。
• N：表示数字（Number），通常用于表示数字类型，如整数、浮点数等。
• S, U, V 等：用于表示第二、第三、第四个泛型类型参数，这些字母并没有固定的含义，但在代码中的使用已经成为了一种约定俗成的规范。