个人封装的 Controller 的返回值封装类

虽然结构都是 code、msg、data 三个参数。

但友好且可控的封装，能更好的约束后续研发人员的扩展。

package com.example.demo.utils;

import lombok.Data;

import java.io.Serializable;

/**
 * @author Rain
 * @date 2023/11/30
 */

@Data
public class Result implements Serializable {

    private Integer code;
    private String msg;
    private T data;

    private Result(){
        
    }

    private static  Result build(Label label) {
        return build(label, null);
    }

    private static  Result build(Label label, T result) {

        return build(label, label.name(), result);
    }

    private static  Result build(Label label, String message, T result) {
        Result resultJson = new Result<>();
        resultJson.code = label.code;
        resultJson.msg = message;
        resultJson.data = result;
        return resultJson;
    }



    public static enum Label {

        /**
         * code 遵守如下约定：
         * 正数 代表 期望现象；
         * 负值 代表悲观现象；
         * 0 代表 基本符合预期。
         */
        Success(0),

        Failure(-1),

        FAILED_InvalidParameter(-2),

        FAILED_UnsupportedDataSourceType(-3),

        FAILED_UnauthorizedCodeOfDataLake(-4);

        private Integer code;

        Label(Integer code) {
            this.code = code;
        }

        public  Result as(){
            return Result.build(this);
        }

        public  Result as(T data){
            return Result.build(this,data);
        }
    }
}

在controller 内使用时，是这样的：

@ApiOperation("获取系列 字典")
@GetMapping(value = "/x1")
@ResponseBody
public Result> x1() {

	return Result.Label.Success.as(this.service.x1());

}

或这样的：

	@PostMapping(value = "/x2")
	@ResponseBody
	public Result> x2(
			@RequestParam(required = true)  String dataSourceType,
			@RequestParam(required = true)  String partNumber) {
		if(!StringUtils.hasText(dataSourceType)||!StringUtils.hasText(partNumber)){
			return Result.Label.FAILED_InvalidParameter.as();
		}

		SearchService service = this.getService(dataSourceType);
		if(service==null){
			return Result.Label.FAILED_UnsupportedDataSourceType.as();
		}

		return Result.Label.Success.as(service.x2(dataSourceType,partNumber);
	}

这里，既保持了风格的简洁性、使用的易用性。又限制了研发人员,让他们必须去 label 内定义清楚自己还生成什么作用的返回值（不能随便拿个创造 code 、msg，就直接让 controller 返回)