Encapsulation of unified result set

Unified return result set
1.

View the information of the unified returned results ： Generally at least 4 individual

Success   //  Whether it is right  boolean

Message //  Returned message 

Code //  Status code 

Data //  Data 

2. Specific steps

1、 First create an enumeration , Create variables that return success and failure ;

2、 Create return object class ;

a) It is recommended to have one OK Methods ,error Method is convenient to call ;

b) Self defined message,success,code,data Methods

3. Examples of enumeration classes are as follows :

@Getter
public enum  ResultCodeEnum {
    SUCCESS(true, 20000," success "),
    UNKNOWN_REASON(false, 20001, " Unknown error "),
    BAD_SQL_GRAMMAR(false, 21001, "sql Grammar mistakes "),
    JSON_PARSE_ERROR(false, 21002, "json Parsing exceptions "),
    PARAM_ERROR(false, 21003, " parameter is incorrect "),
    FILE_UPLOAD_ERROR(false, 21004, " File upload error "),
    EXCEL_DATA_IMPORT_ERROR(false, 21005, "Excel Data import error ");

    private Boolean success;
    private Integer code;
    private String message;
    private ResultCodeEnum(Boolean success, Integer code, String message) {
        this.success = success;
        this.code = code;
        this.message = message;
    }
}

4. Unified return object class Examples are as follows :

@Data
@ApiModel(value = " Global unified return results ")
public class R {

    @ApiModelProperty(value = " The success of ")
    private Boolean success;

    @ApiModelProperty(value = " Return code ")
    private Integer code;

    @ApiModelProperty(value = " Return message ")
    private String message;

    @ApiModelProperty(value = " Return the data ")
    private Map<String, Object> data = new HashMap<String, Object>();

    private R(){}

    public static R ok(){
        R r = new R();
        r.setSuccess(ResultCodeEnum.SUCCESS.getSuccess());
        r.setCode(ResultCodeEnum.SUCCESS.getCode());
        r.setMessage(ResultCodeEnum.SUCCESS.getMessage());
        return r;
    }

    public static R error(){
        R r = new R();
        r.setSuccess(ResultCodeEnum.UNKNOWN_REASON.getSuccess());
        r.setCode(ResultCodeEnum.UNKNOWN_REASON.getCode());
        r.setMessage(ResultCodeEnum.UNKNOWN_REASON.getMessage());
        return r;
    }
    public static R setResult(ResultCodeEnum resultCodeEnum){
        R r = new R();
        r.setSuccess(resultCodeEnum.getSuccess());
        r.setCode(resultCodeEnum.getCode());
        r.setMessage(resultCodeEnum.getMessage());
        return r;
    }

    public R success(Boolean success){
        this.setSuccess(success);
        return this;
    }

    public R message(String message){
        this.setMessage(message);
        return this;
    }

    public R code(Integer code){
        this.setCode(code);
        return this;
    }

    public R data(String key, Object value){
        this.data.put(key, value);
        return this;
    }

    public R data(Map<String, Object> map){
        this.setData(map);
        return this;
    }
}

5. Test the following :

/*
*  Query methods 
* */
@ApiOperation(value = "person1 Query data ")
@ResponseBody
@GetMapping("/selectOnePerson/{id}")
public R selectOnePerson(@ApiParam(name="id", value = "personID", required = true) @PathVariable("id") Integer id) {

    try {
       Person person = personServer.selectOne(id);
        return R.ok().data("person",person);
    } catch (Exception e) {
        return R.error();
    }
}