SpringBoot项目中Controller层代码编写规范整理方式

    //返回map可读性不好，尽量不要　
    @PostMapping("/delete") 
    public Map<String, Object> delete(long id, String lang) { } 
    // 成功返回boolean，失败返回string，大忌 
    @PostMapping("/delete") 
    public Objectdelete(long id, String lang) { 
        try { 
            boolean result = configService.delete(id, local); return result; 
        } catch (Exception e) {
            log.error(e); return e.toString(); 
        } 
    }

//不返回任何数据，没有考虑失败场景，容易返工　
＠PostMapping("/update") public void update(long id, xxx) { }

// （当前用户删除数据）参数出现lang和userid，尤其是userid，大忌　
＠PostMapping("/delete") 
public Map<String, Object> delete(long id,String lang, String userId) { }

// 参数出现json格式，可读性不好，代码也难看　
＠PostMapping("/update") public Map<String, Object> update(long id, String jsonStr) { }

// 约定俗成，新建应该返回新对象的信息，只返回boolean容易导致返工　
＠PostMapping("/add") 
public boolean add(xxx) { //xxx return configService.add(); }

/**
 * Controller统一返回对象，响应信息主体
 */
@Getter
@ApiModel(value = "响应信息主体")
public class R<T> implements Serializable {

    private static final long serialVersionUID = 1L;
    /**
     * 状态码：1成功，其他均为失败【详见错误状态码表】
     */
    @ApiModelProperty(value = "状态码")
    private int code;
    /**
     * 成功为success，其他为失败原因
     */
    @ApiModelProperty(value = "消息")
    private Object message = "success";
    /**
     * 数据结果集
     */
    @ApiModelProperty(value = "数据结果集")
    private T data;
    /**
     * 当前时间
     */
    @ApiModelProperty(value = "时间戳")
    private final long time = System.currentTimeMillis();

    public R<T> setMessage(Object message) {
        this.message = message;
        return this;
    }

    public R<T> setMessage(String format, Object... args) {
        this.message = new Formatter().format(format, args).toString();
        return this;
    }

    public R() {
    }

    /**
     * 使用枚举类中模版消息
     *
     * @param resultConstant ResultConstant
     * @param data           数据结果集
     */
    private R(ResultConstant resultConstant, T data) {
        this.code = resultConstant.getCode();
        this.message = resultConstant.getMessage();
        this.data = data;
    }

    public static <T> R<T> ok() {
        return restResult(ResultConstant.SUCCESS, null, null);
    }

    public static <T> R<T> ok(T data) {
        return restResult(ResultConstant.SUCCESS, null, data);
    }

    public static <T> R<T> ok(T data, Object message) {
        return restResult(ResultConstant.SUCCESS, message, data);
    }

    public static <T> R<T> failed(ResultConstant resultConstant) {
        return restResult(resultConstant, null, null);
    }

    public static <T> R<T> failed(ResultConstant resultConstant, Object message) {
        return restResult(resultConstant, message, null);
    }

    public static <T> R<T> failed(ResultConstant resultConstant, Object message, T data) {
        return restResult(resultConstant, message, data);
    }

    private static <T> R<T> restResult(ResultConstant resultConstant, Object message, T data) {
        R<T> apiResult = new R<>(resultConstant, data);
        if (null != message) {
            apiResult.setMessage(message);
        }
        return apiResult;
    }
}