Java接口响应封装类
Web开发中，前后分离是个趋势，现在大部分公司研发部门已经在走前后分离的路子了，前后分离开发各司其职能够有效的提高工作效率和开发质量。
REST接口会返回各种各样的数据，如果对接口的格式不加约束，很容易造成混乱。
在实际项目中，一般会把结果放在一个封装类中，封装类中包含http状态值，状态消息，以及实际的数据。

个人总结一下工作中用到的接口响应类。😃


状态枚举，接口响应状态码、消息，统一在此枚举类中定义，方便阅读、修改。

/**
 * 响应状态码枚举
 * @author liuyang
 * 2020-01-13
 */
public enum CodeEnum {

    SUCCESS(0, "成功"),
    FAIL(1, "失败"),
    ;

    private final Integer code;

    private final String msg;
  // 省略枚举构造方法、get、set方法
}


数据响应基类，方便以后扩展子类，也可用于增、删、改相关接口响应。

/**
 * 响应数据基类
 * @author liuyang
 * 2020-01-13
 */
public class BaseResponse {

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

    /**
     * 响应消息
     */
    private String msg;

    protected BaseResponse() {}

    protected BaseResponse(CodeEnum code) {
        this.code = code.getCode();
        this.msg = code.getMsg();
    }
  // 省略get/set方法
}


响应数据体，继承自 BaseResponse 类，增加了 范型 属性，方便响应各种数据。

/**
 * 响应数据体
 * @author liuyang
 * 2020-01-13
 */
public class ResponseData<T> extends BaseResponse {

    /**
     * 数据
     */
    private T data;

    private ResponseData(CodeEnum code) {
        super(code);
    }

    private ResponseData(CodeEnum code, T data) {
        super(code);
        this.data = data;
    }

    /**
     * 对外开放基础响应体已供调用，可用于增、删、改接口操作
     */
    public static BaseResponse out(CodeEnum code) {
        return new BaseResponse(code);
    }

    /**
     * 对外开放数据响应体已供调用，可用于查询数据实用，引用了范型设计，支持各种数据类型
     */
    public static <T> ResponseData<T> out(CodeEnum code, T data) {
        return new ResponseData<>(code, data);
    }
  // 省略get/set方法
}

以上三个类足可以满足日常开发，顺带说一句，CodeEnum枚举类也可用于定义处于业务异常逻辑，比如：抛出用户不存在的异常，然后配合Spring MVC的 @ControllerAdvice注解，统一响应异常信息。（如果不明白，可在评论区说明，可以考虑再出一篇针对异常处理的文章）

进入测试------------------------


基础响应，此处模拟删除

@GetMapping("/user/del/{userId}")
public BaseResponse delUser(@PathVariable Integer userId) {
	return ResponseData.out(CodeEnum.FAIL);
}

访问：localhost:8080/user/del/1
响应：
{
    "code": 1,
    "msg": "失败"
}


数据体响应，此处模拟用户列表

@GetMapping("/user-info")
public ResponseData<List<String>> userInfo() {
  List<String> list = new ArrayList<>();
  list.add(UUID.randomUUID().toString());
  list.add(UUID.randomUUID().toString());
  list.add(UUID.randomUUID().toString());
  list.add(UUID.randomUUID().toString());
  return ResponseData.out(CodeEnum.SUCCESS, list);
}

访问：localhost:8080/user-info
响应：
{
    "code": 0,
    "msg": "成功",
    "data": [
        "003252cf-3361-43c4-8fdc-b9091f83ea05",
        "6320cd96-ae04-4885-ac78-76241f19ac95",
        "34cdd394-97d4-4e7d-993f-e4688b86d0e0",
        "bd293a9e-465b-4796-b8fa-17fc37de9bf7"
    ]
}

以上，测试成功。
PS：可在此基础上加入一些符合自己需要的属性，比如：响应时间戳、响应标识等等…

一.封装类的构造器：
1.对基本数据类型：Integer i=new Integer(10);
2.对字符型：Integer i=new Integer("10");

二.封装类的3种方法:
1.valueOf();//静态方法，返回的是一个指定类型的封装类实例（目前jdk支持自动装箱与拆箱）
2.***Value();//把封装类对象转化成基本数据类型的值
3.parse***();//把String的对象转化成封装类对象

三.几点补充
1.关于valueOf，例如Integer i=Integer.valueOf("10010")其将字符串转化成Integer类型的对象
2.关于parseInt，例如Integer a=Integer.parseInt("12");
3.关于IntValue，
例如：我们可以使用4种方法创建一个Integer的对象（装箱）；
<1>Integer a=new Integer("100");//在cmd命令下编译时提示使用或覆盖了过时的API，但是eclipse就没问题（貌似是系统不推荐用户显式使用）
<2>Integer a=100;//但是实际是调用1的方法
<3>Integer a=Integer.valueOf("100");//调用封装类的方法
<4>Integer a=parseInt("100");


*封装类的另一个的方法：***Value();
例如：
Integer a=100;
int val=a.IntValue();//记得import java.lang.*;(拆箱)

四.其他说明
&关于Integer的对象i的i++操作：
1.先对i拆箱->val=i.intValue();
2.再实现val的自加->val++;
3.再装箱->i=new Integer(val)




&关于常量池的概念
如果有:
Integer a=new integer(50);//a=50;
Integer b=new Integer(50);//b=50;
System.out.println(a==b);


输出：
True


按照常理来说a、b都用了new，应该占用不同的内存单元，但是常量池(-128~127)的存在是的a、b同指向池中的同一单元

//Wrapper
import java.lang.*;
public class Main {
	public static void main(String args[]) {
		int a=1;
		//Integer b = new Integer(a);
		Integer c = Integer.valueOf(a);//valueOf()将基本数据类型转化为封装类
		Integer d = Integer.parseInt("1");
		int e = c.intValue();
		System.out.println(e);
	}
}

       JavaMailSenderImpl是spring封装的邮件发送封装类，支持普通文本、附件、html。博主今天用到了用qq邮箱发送普通文本，以后若用到了其他，再补充在下面。

1.导入mail的包

<dependency>
    <groupId>javax.mail</groupId>
    <artifactId>mail</artifactId>
    <version>1.4.7</version>
</dependency>

2.邮箱服务器设置

用qq邮箱的smtp邮件服务器，前提之一是关闭登录保护，开启邮箱登录保护，无法使用smtp服务。若开启了，前往安全中心关闭。



前提之二是开启smtp服务，在邮箱的设置-账号设置-开启服务里查看是否开启了POP3/SMTP服务。开启之后，会显示一个授权码。此授权码作为发件方的密码，qq邮箱可能作为安全考虑，防止邮箱密码泄露。



 修改邮箱密码之后，授权码会失效，要想获取新的授权码，开启服务的下方点击生成授权码链接，即可得到新的16位授权码。



上面的前提步骤满足后，JavaMailSenderImpl就能正常使用。

创建邮件服务器的时候，注意端口号不需要设置，邮件服务器会访问默认端口。博主试过加上端口号反而邮件发不出去，不加端口号却能正常发送。



3.发送邮件关键代码

	public void simpleMailSend(String email,String subject,String msg) {
	 //创建邮件发送服务器
        JavaMailSenderImpl mailSender = new JavaMailSenderImpl();  
        mailSender.setHost("smtp.qq.com");
//      mailSender.setPort(465);
        mailSender.setUsername("2118724165@qq.com");
        mailSender.setPassword("");
        //加认证机制
        Properties javaMailProperties = new Properties();
    	javaMailProperties.put("mail.smtp.auth", true); 
    	javaMailProperties.put("mail.smtp.starttls.enable", true); 
    	javaMailProperties.put("mail.smtp.timeout", 5000); 
        mailSender.setJavaMailProperties(javaMailProperties);
        //创建邮件内容
        SimpleMailMessage message=new SimpleMailMessage();
        message.setFrom("2118724165@qq.com");
        message.setTo(email);
        message.setSubject(subject);
        message.setText(msg);
        //发送邮件
        mailSender.send(message);
	}

JavaMailSenderImpl的几个属性设置说明如下：

Host：邮箱服务器主机。

Port：端口号。

Username：发件方账户。

Password：密码，qq邮箱的话此处设置16位授权码，不是邮箱密码，切记！

mail.smtp.auth:认证机制开关，记得开启。

mail.smtp.starttls.enable：TLS通讯协议开关，连接qq的SMTP服务器，需使用此通讯协议。

mail.smtp.timeout ：连接超时时间，单位毫秒。

发送文本消息用SimpleMailMessage类

它的几个重要属性说明如下：

From发件方的账户，和Username的值相同

To收件方

Subject邮件主题

Text邮件内容

项目中用到，比较好用！！ 

用户前端与后台的交互数据，这个封装类中包含分页、数据、错误码、状态码等信息！！ 

亲测好用哦！



一个类DataWrapper



public class DataWrapper<T>{
    private CallStatusEnum callStatus;
    private ErrorCodeEnum errorCode;
    private T data;
    private int numberPerPage; // 用于分页结果
    private int currentPage;
    private int totalNumber;
    private int totalPage;
    private String message ;
    private String recordUpdateTime ; //redis数据插入时间

    public DataWrapper() {
        callStatus = CallStatusEnum.SUCCEED;
        errorCode = ErrorCodeEnum.No_Error;
    }

    public static <T> DataWrapper<T> createInstance(){
        return new DataWrapper<T>() ;
    }

    public CallStatusEnum getCallStatus() {
        return callStatus;
    }

    public DataWrapper<T> setCallStatus(CallStatusEnum callStatus) {
        this.callStatus = callStatus;
        return this ; 
    }

    public ErrorCodeEnum getErrorCode() {
        return errorCode;
    }

    public void setErrorCode(ErrorCodeEnum errorCode) {
        this.errorCode = errorCode;
        if (!errorCode.equals(ErrorCodeEnum.No_Error)) {
            this.callStatus = CallStatusEnum.FAILED;
        }
    }

    public T getData() {
        return data;
    }

    public DataWrapper<T> setData(T data) {
        this.data = data;
        return this ;
    }


    public int getNumberPerPage() {
        return numberPerPage;
    }

    public void setNumberPerPage(int numberPerPage) {
        this.numberPerPage = numberPerPage;
    }

    public int getCurrentPage() {
        return currentPage;
    }

    public void setCurrentPage(int currentPage) {
        this.currentPage = currentPage;
    }

    public int getTotalNumber() {
        return totalNumber;
    }

    public void setTotalNumber(int totalNumber) {
        this.totalNumber = totalNumber;
    }

    public int getTotalPage() {
        return totalPage;
    }

    public void setTotalPage(int totalPage) {
        this.totalPage = totalPage;
    }

    public String getMessage() {
        return message;
    }

    public DataWrapper<T> setMessage(String message) {
        this.message = message;
        return this ;
    }

    public String getRecordUpdateTime() {
        return recordUpdateTime;
    }

    public DataWrapper<T>  setRecordUpdateTime(String recordUpdateTime) {
        this.recordUpdateTime = recordUpdateTime;
        return this ;
    }

    @Override
    public String toString() {
        return  JSONObject.toJSONString(this) ;
    }
}



两个枚举CallStatusEnum、ErrorCodeEnum



public enum CallStatusEnum implements Serializable {
    SUCCEED,
    FAILED,;

    CallStatusEnum() {
    }
}



public enum ErrorCodeEnum implements Serializable {
    No_Error("No ERROE!", 0),
    Error("Unknown error!", 1),
    NO_SUCH_USER("Can't find username",2),
    IncorrectCredentials("IncorrectCredentialsException",3),
    LoginFailed("AuthenticationException",4),
    USER_EXIST("User already exist in db",5),
    PASSWORD_ERROR("Error is password",6),
    REGISTER_FAILED("Register failed",7),
    PARSE_DATE("Parse  Date error",8),
    ExcessiveAttempts("Try password more than 5 times",9) ,
    NO_ROLE("User has no role!" , 10) ,
    USER_STATE_ERROR("User state error! Disable Login" , 11),
    USER_IDENTITY_ERROR("User Identity error! Disable Login" , 12),
    DB_ERROR("database maybe error!" , 13) ,
    WEB_SP_ERROR("from webSp maybe error!" , 14) ,
    MFA_VERIFY_ERROR("mfa verify random code error!" , 15) ,
    MFA_SEND_ERROR("mfa send random code error!" , 16) ,
    MFA_SEND_EXCESSIVE("ask send random code excessive!" , 17),
    PHONE_NUMBER_ERROR("phone number is empty or error!" , 18),
    IMAGECODE_ERROR("image code error" , 19),
    VERIFYCODE_ERROR("telephone verify code incorrect",20);

    private String label;
    private Integer code;

    ErrorCodeEnum() {
    }

    ErrorCodeEnum(String label, Integer code) {
        this.label = label;
        this.code = code;
    }

    public String getLabel() {
        return label;
    }

    public void setLabel(String label) {
        this.label = label;
    }

    public int getCode() {
        return code;
    }

    @Override
    public String toString() {
        return code.toString();
    }

    public static ErrorCodeEnum parse(int code) {
        for (ErrorCodeEnum theEnum : ErrorCodeEnum.values()) {
            if (theEnum.getCode() == code) {
                return theEnum;
            }
        }
        return No_Error;
    }
}