后端响应到前端数据包装类、泛型

╰半夏微凉° 2023-10-06 17:24 56阅读 0赞

分享一个返回前端数据的包装类

package com.xx.xx.rest;
    
    import java.io.Serializable;
    
    /**
     * 泛型，即“参数化类型”。顾名思义，就是将类型由原来的具体的类型参数化，此时类型也定义成参数形式，然后在使用/调用时传入具体的类型。
     * 泛型只在编译阶段有效，在编译之后程序会采取去泛型化的措施，“参数化类型”变成具体的类型。
     * 泛型通配符：当具体类型不确定的时候，使用泛型通配符“?”
     * 泛型类：是在实例化类的时候指明泛型的具体类型。泛型类型用于类的定义中，被称为泛型类。包括成员变量的类型为T、类名称后为<T>。
     * 泛型方法：是在调用方法的时候指明泛型的具体类型 。只有声明了<T>的方法才是泛型方法，泛型类中的使用了泛型的成员方法并不是泛型方法。
     * 定义的泛型类，就一定要传入泛型类型实参么？
     * 并不是这样，在使用泛型的时候如果传入泛型实参，则会根据传入的泛型实参做相应的限制，此时泛型才会起到本应起到的限制作用。
     * 如果不传入泛型类型实参的话，在泛型类中使用泛型的方法或成员变量定义的类型可以为任何的类型。
     * @author lhs
     */
    public class RestResponse<T> implements Serializable {
    	private static final long serialVersionUID = -4577255781088498763L;
    	private static final Integer SUCCESS = 200;
    	private static final Integer FAIL = 201;
    	private static final Integer UNAUTHORIZED = -1;
    
    	private T data; // 服务端数据
    	private Integer code; // 状态码
    	private String msg; // 描述信息
    
    	// APIS
    	public static RestResponse<?> success() {
    		return new RestResponse<>().setCode(SUCCESS);
    	}
    
    	/*
    	 * 1）public 与 返回值中间<T>非常重要，可以理解为声明此方法为泛型方法。
    	 * 2）只有在返回值前声明了<T>的方法才是泛型方法，泛型类中的使用了泛型的成员方法并不是泛型方法。
    	 * 3）<T>表明该方法将使用泛型类型T，此时才可以在方法中使用泛型类型T。
    	 * 4）与泛型类的定义一样，此处T可以随便写为任意标识，常见的如T、E、K、V等形式的参数常用于表示泛型。
    	 */
    	// 这才是一个真正的泛型方法。只有在返回值前声明了<T>的方法才是泛型方法。
    	// 静态方法要使用泛型形参的话，必须将静态方法也定义成泛型方法
    	public static <T> RestResponse<?> success(T data) {
    		return new RestResponse<>().setData(data).setCode(SUCCESS);
    	}
    
    	public static RestResponse<?> fail() {
    		return new RestResponse<>().setCode(FAIL);
    	}
    
    	public static RestResponse<?> unauthorized() {
    		return new RestResponse<>().setCode(UNAUTHORIZED);
    	}
    
    	public static RestResponse<?> fail(Throwable e) {
    		return fail().msg(e);
    	}
    
    	public RestResponse<?> msg(String msg) {
    		this.setMsg(msg);
    		return this;
    	}
    
    	public RestResponse<?> msg(Throwable e) {
    		this.setMsg(e.toString());
    		return this;
    	}
    
    	public RestResponse<?> data(T data) {
    		this.setData(data);
    		return this;
    	}
    
    	// 构造方法
    	public RestResponse() {
    		super();
    	}
    
    	// Getter&Setters
    	// 这并不是一个泛型方法
    	public T getData() {
    		return data;
    	}
    
    	public RestResponse<T> setData(T data) {
    		this.data = data;
    		return this;
    	}
    
    	public Integer getCode() {
    		return code;
    	}
    
    	public RestResponse<?> setCode(Integer code) {
    		this.code = code;
    		return this;
    	}
    
    	public String getMsg() {
    		return msg;
    	}
    
    	public RestResponse<?> setMsg(String msg) {
    		this.msg = msg;
    		return this;
    	}
    
    }

使用示例

@GetMapping("/query")
    	public String queryPushTask(Integer id) {
    		log.info("查询推送任务");
    		RestResponse<?> rest = pushTaskService.queryPushTask(id);
    		return JSON.toJSONString(rest);
    	}

@Override
    	public RestResponse<?> queryPushTask(Integer id) {
    		try {
    			PushTask task = pushTaskMapper.selectByPrimaryKey(id);
    			//RestResponse.success().setMsg("查询推送任务成功");
    			return RestResponse.success(task).setMsg("查询推送任务成功");
    		} catch (Exception e) {
    			e.printStackTrace();
    		}
    		return RestResponse.fail().setMsg("查询推送任务失败");
    	}