全局统一返回结果类

小咪咪 2024-04-03 11:42 94阅读 0赞

一般情况下，统一返回数据格式没有固定的格式，  
但是一般会包含状态码、返回消息、数据这几部分内容

##### 先定义一个枚举类，方便设置各种返回状态 #####

@Data
    public enum ResultCodeEnum(){
        
    	SUCESS(200,"成功"),
    	FAIL(201,"失败"),
    	SERVICE_ERROR(203, "服务异常");
    	
    	private Integer code;
    	private String message;
    
    	private ResultCodeEnum(Integer code,String message){
        
    		this.code = code;
    		this.message = message;
    	}
    }

##### 全局统一返回结果类 #####

@Data
    public class Result<T>(){
        
    	//返回码
    	private Integer code;
    	//返回消息
    	private String message;
    	//返回数据
    	private T data;
    
    	public Result(){
        }
    
    	protected static<T> Result<T> build(T data){
        
    		Result<T> result = new Result<T>();
    		if(data != null){
        
    			result.set(data);	
    		}
    		return result;
    	}
    
    	public static<T> Result<T> build(T data,ResultCodeEnum resultCodeEnum){
        
    		Result<T> result = build(data);
    		result.setCode(resultCodeEnum.getCode());
    		result.setMessage(resultCodeEnum.getMessage());
    		return result;
    	}
    
    	public static<T> Result<T> build(Integer code,String msg){
        
    		Result<T> result = build(null);
    		result.setCode(code);
    		result.setMessage(msg);
    		return result;
    	}
    
    	public static<T> Result<T> ok(){
        
    		return Result.ok(null);
    	}
    
    	/**
         * 操作成功
         */
    	public static<T> Result<T> ok(T data){
        
    		return build(data,ResultCodeEnum.SUCCESS);
    	}
    
    	public static<T> Result<T> fail(){
        
    		return Result.fail(null);
    	}
    
    	/**
         * 操作失败
         */
    	public static<T> Result<T> fail(T data){
        
    		return Result.build(data,ResultCodeEnum.FAIL);
    	}
    
    	public Result<T> setCode(Integer code){
        
    		this.setCode();
    		return this;
    	}
    
    	public Result<T> setMessage(String message){
        
    		this.setMessage();
    		return this;
    	}
    
    }

##### controller层调用示例 #####

@RestController
    @RequestMapping("/admin/hosp/hospitalSet")
    public class HospitalSetController {
        
    
    	@Autowired
        HospitalSetService hospitalSetService;
    
        @ApiOperation(value = "获取所有设置信息")
        @GetMapping("/findAll")
        public Result findAll(){
        
            List<HospitalSet> list = hospitalSetService.list();
            return Result.ok(list);
        }
    
    }