springboot接口统一规范封装

笔记参考：https://www.cnblogs.com/kaibindirver/p/16358813.html

目录:

 

 

 

 Constants     ---常量

package com.全局捕获.common;

public interface Constants {

    String CODE_200 = "200"; //成功
    String CODE_401 = "401";  // 权限不足
    String CODE_400 = "400";  // 参数错误
    String CODE_500 = "500"; // 系统错误
    String CODE_600 = "600"; // 其他业务异常

    String DICT_TYPE_ICON = "icon";

    String FILES_KEY = "FILES_FRONT_ALL";

}

Result    ----扔出前端响应的模版

package com.common;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author: Amim
 * @year: 2022/9
 **/
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result {

    private String code;
    private String msg;
    private Object data;

    public static Result success() {
        return new Result(Constants.CODE_200, "", null);
    }

    public static Result success(Object data) {
        return new Result(Constants.CODE_200, "测试成功", data);
    }

    public static Result error(String code, String msg) {
        return new Result(code, msg, null);
    }

    public static Result error(String s) {
        return new Result(Constants.CODE_500, "系统错误", null);
    }

}

UserDTO

package com.Control.dto;

import lombok.Data;

/**
 * @author: Amim
 * @year: 2022/9
 **/

@Data
public class UserDTO {
    private String username;
}

CatFood

package com.Control;

import com.Service.CatFoodService;
import com.common.Constants;
import com.common.Result;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author: Amim
 * @year: 2022/9
 **/

@RestController
@RequestMapping("/food")
public class CatFood {

    @Autowired
    CatFoodService catFoodService;

    //给猫粮记录的接口
    @PostMapping("/addfoodtime")
    public Object GiveFood() {
        try {
            String ff = catFoodService.MarkFood();
            //  return catFoodService.MarkFood();
            return Result.success(ff);
        } catch (Exception e) {
            System.out.println("看这里" + e);
            return Result.error(Constants.CODE_401, e.getClass().toString());
        }
    }

    //记录水的接口
    @PostMapping("/addwatertime")
    public Result GiveWater() {
        try {
            String dd = catFoodService.MarkWater();
            // return  catFoodService.MarkWater();
            return Result.success(dd);
        } catch (Exception e) {
            System.out.println("看这里" + e);
            return Result.error(Constants.CODE_401, e.getClass().toString());
        }
    }
//获取给水的接口
    @GetMapping("/getwatertime")
    public Result GetWater(){
        try {
            String tt = catFoodService.GetWaterList();
            //  return  catFoodService.GetWaterList();
            return Result.success(tt);
        } catch (Exception e) {
            System.out.println("看这里" + e);
            return Result.error(Constants.CODE_401, e.getClass().toString());
        }
    }
}

GlobalExceptionHandler     -----如果有逻辑调用 ServiceException 方法，那么这边会接收他对应的参数且去执行handle方

package com.exception;

import com.common.Result;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * @author: Amim
 * @year: 2022/9
 **/
@ControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 如果抛出的的是ServiceException，则调用该方法
     * @param se 业务异常
     * @return Result
     */
    @ExceptionHandler(ServiceException.class)
    @ResponseBody
    public Result handle(ServiceException se){
        return Result.error(se.getCode(), se.getMessage());
    }

}

ServiceException

package com.exception;

import lombok.Getter;

/**
 * @author: Amim
 * @year: 2022/9
 **/
@Getter
public class ServiceException extends RuntimeException {
    private String code;

    public ServiceException(String code, String msg) {
        super(msg);
        this.code = code;
    }

}