程序员必看内容连续集之 SpringBoot02 入门&统一响应类及错误编码类

谁践踏了优雅 2024-04-01 14:34 45阅读 0赞

**目录**

一、SpringBoot简介

二、SpringBoot入门

三、统一响应类及错误编码类

--------------------

## 一、SpringBoot简介 ##

### 1、SpringBoot是什么**？** ###

![b6cec81d5d074cc9897583bfc3e24ecd.jpeg][]

> Spring Boot它**本身并不提供Spring框架**的核心特性以及扩展功能，只是用于快速、敏捷地开发新一代**基于Spring框架的应用程序**。  
> 也就是说，它并不是用来替代Spring的解决方案，而是和Spring框架紧密结合用于提升Spring开发者体验的工具
> 
> 同时它集成了大量常用的第三方库配置（例如Jackson, JDBC, Mongo, Redis, Mail等等），  
> Spring Boot应用中这些第三方库几乎可以零配置的开箱即用（out-of-the-box），大部分的Spring Boot应用都  
> **只需要非常少量的配置代码，开发者能够更加专注于业务逻辑**

### 2、springboot的特点 ###

> **1：敏捷式开发；  
> 2：spring boot其实不是什么新的框架，它默认配置了很多框架的使用方式，就像maven整合了所有的jar包，spring boot整合了所有的框架；  
> 3：基于Spring框架的一站式解决方案；**

## 二、SpringBoot入门 ##

### 1、创建一个SpringBoot项目 ###

> 接下来我们使用Idea创建一个SpringBoot项目，用来熟悉我们的入门操作：
> 
> ![69592c77ebdb49bb99729cd6ffb98370.png][]
> 
> ![248b6bf3e3714c5c9034026aa292c848.png][]
> 
> ![1caeea8886c24f80af6fbc6e0430e5ee.png][]
> 
> ![cb01a49059974273b20598468ec5e9f7.png][]
> 
> ![069ed5453f08472ea7b037479b37036b.png][]
> 
> ![f60bedc4318c4904984592ad720a1a25.png][]
> 
> ![d48f2947d87848ccad98ad44a7b12854.png][]
> 
> **注意：插件之间可能存在配置关系，比如第三个Mybatis Framework，这个插件就是需要自己配置数据库，如果不配置，那么启动项目是会报错的，所以我们来配置一下避免运行时报错，我们这里使用的是**不添加数据库配置，加入注解直接让其排除自动配置类：
> 
>     @SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
> 
> ![02e8ce4492444515b63a18be69b821fb.png][]

### 2、测试创建的项目 ###

> 接下来我们创建一个测试的访问层，来试试我们现在配置完了的SpringBoot项目能不能使用：
> 
>     package com.zq.springboot01.web;
>     
>     import org.springframework.web.bind.annotation.RequestMapping;
>     import org.springframework.web.bind.annotation.RestController;
>     
>     /**
>      * @author张强
>      * @site www.zq.com
>      */
>     // 等价于@responseBody + @controller
>     @RestController
>     public class IndexController {
>     
>         @RequestMapping("/")
>         public String index() {
>             System.out.println("come in");
>             //返回是index字符串
>             return "index";
>         }
>     
>     }
> 
> 我们直接运行项目，**因为在SpringBoot是不需要配置Tomcat的！**  
> ![54c1f478d9f3439d9b459ea0eb0fe66b.png][]
> 
> ![d9277e486a3e4f2dacbd6b42b0c8d400.png][]

### 3、SpringBoot项目路径介绍 ###

> ![83410ea9da3a488c839885bb7df4c0a9.png][]![4a99744f19684837812567bd50ff582d.png][]

### 4、下载安装 Convert YAML and Properties File 的插件 ###

> 下载这个插件是为了我们后续的配置会更多，所以在application.propertiles或者yml文件会更多的配置代码，为了更加清晰的管理这两个文件，我们采用这个插件来管理
> 
> ![39649bcbde8e4ac88e43cff6b096096f.png][]
> 
> 下载完后我们重启Idea并且使用这个插件来管理一下我们刚才的application.properties文件
> 
> ![24003724629846268487d61b9479601a.png][]
> 
> 使用之后的效果：
> 
> ![47fe9b715735465b9f2feda6f176fda8.png][]

## 三、统一响应类及错误编码类 ##

### 1、测试工具介绍： ###

我们现在使用Springboot做一个增删改查：

BookController：

package com.zq.springboot01.web;
    
    import lombok.AllArgsConstructor;
    import lombok.Data;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.Arrays;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    
    /**
     * @author张强
     * @site www.zq.com
     */
    
    @RestController
    @RequestMapping("/book")
    public class BookController {
        @RequestMapping("/list")
        public Map list(){
    //        查询数据库(做假的数据)
            List<Book> books = Arrays.asList(new Book(1, "西游记"),
                    new Book(2, "三国演义"),
                    new Book(3, "水浒传"),
                    new Book(4, "红楼梦"));
            Map map=new HashMap();
            map.put("data",books);
            map.put("total",122);
            map.put("msg","查询成功");
            map.put("code",200);
            return map;
        }
    
        @RequestMapping("/add")
        public Map add(){
            Map map=new HashMap();
            map.put("msg","新增成功");
            map.put("code",200);
            return map;
        }
    
        @RequestMapping("/update")
        public Map update(){
            Map map=new HashMap();
            map.put("msg","修改成功");
            map.put("code",200);
            return map;
        }
    
        @RequestMapping("/del")
        public Map del(){
            Map map=new HashMap();
            map.put("msg","删除成功");
            map.put("code",200);
            return map;
        }
    
        @RequestMapping("/load")
        public Map load(){
            Map map=new HashMap();
            map.put("data",new Book(1,"西游记"));
            map.put("msg","查询成功");
            map.put("code",200);
            return map;
        }
    }
    
    @AllArgsConstructor
    @Data
    class Book{
        private int id;
        private String name;
    }

模拟测试：返回结果成功！![48c002382f594b7fa5bda3c0925292f9.png][]

但是我们在开发中是会更换他的注解的换成更加清晰的响应注解以便我们看到就清楚这个是返回什么结果：

package com.zq.springboot01.web;
    
    import lombok.AllArgsConstructor;
    import lombok.Data;
    import org.springframework.web.bind.annotation.*;
    
    import java.util.Arrays;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    
    /**
     * @author张强
     * @site www.zq.com
     */
    
    @RestController
    @RequestMapping("/book")
    public class BookController {
        @GetMapping("/list")
        public Map list(){
    //        查询数据库(做假的数据)
            List<Book> books = Arrays.asList(new Book(1, "西游记"),
                    new Book(2, "三国演义"),
                    new Book(3, "水浒传"),
                    new Book(4, "红楼梦"));
            Map map=new HashMap();
            map.put("data",books);
            map.put("total",122);
            map.put("msg","查询成功");
            map.put("code",200);
            return map;
        }
    
        @PutMapping("/add")
        public Map add(){
            Map map=new HashMap();
            map.put("msg","新增成功");
            map.put("code",200);
            return map;
        }
    
        @PostMapping("/update")
        public Map update(){
            Map map=new HashMap();
            map.put("msg","修改成功");
            map.put("code",200);
            return map;
        }
    
        @DeleteMapping("/del")
        public Map del(){
            Map map=new HashMap();
            map.put("msg","删除成功");
            map.put("code",200);
            return map;
        }
    
        @RequestMapping("/load")
        public Map load(){
            Map map=new HashMap();
            map.put("data",new Book(1,"西游记"));
            map.put("msg","查询成功");
            map.put("code",200);
            return map;
        }
    }
    
    @AllArgsConstructor
    @Data
    class Book{
        private int id;
        private String name;
    }

![1da7cdf4e78949298146a23876bcca61.png][]

> 那么在这里介绍两款测试工具：我们用这个来测试更改响应注释的方法  
> ![26c549a102074c76a9b5b0b49d4c4763.png][]
> 
> ![6bd6e7e4b2894ad9b895830165664a9d.png][]

### 2、 响应封装类： ###

我们在项目中一般在返回结果中一般会采用一个类来存放我们所有的返回结果，这个就是响应的封装类：

Result：

package com.zq.springboot01.result;
    
    public class Result<T> {
     
        private int code;
        private String msg;
        //因为返回的数据不知道是什么类型，所以定义一个泛型
        private T data;
        private long total;
    
        public long getTotal() {
            return total;
        }
    
        public void setTotal(long total) {
            this.total = total;
        }
    
        /**
         * 成功的时候调用
         */
        public static <T> Result<T> ok(T data) {
            return new Result<T>(data);
        }
        public static <T> Result<T> ok(int code,String msg) {
            return new Result<>(code,msg);
        }
        public static <T> Result<T> ok(int code,String msg,T data) {
            Result<T> success = ok(data);
            success.setCode(code);
            success.setMsg(msg);
            return success;
        }
        public static <T> Result<T> ok(int code,String msg,T data,long total) {
            Result<T> success = ok(code,msg,data);
            success.setTotal(total);
            return success;
        }
     
        /**
         * 失败的时候调用
         */
        public static <T> Result<T> error(CodeMsg codeMsg) {
            return new Result<T>(codeMsg);
        }
     
        private Result(T data) {
            this.data = data;
        }
     
        private Result(int code, String msg) {
            this.code = code;
            this.msg = msg;
        }
     
        private Result(CodeMsg codeMsg) {
            if (codeMsg != null) {
                this.code = codeMsg.getCode();
                this.msg = codeMsg.getMsg();
            }
        }
     
        public int getCode() {
            return code;
        }
     
        public void setCode(int code) {
            this.code = code;
        }
     
        public String getMsg() {
            return msg;
        }
     
        public void setMsg(String msg) {
            this.msg = msg;
        }
     
        public T getData() {
            return data;
        }
     
        public void setData(T data) {
            this.data = data;
        }
    }

CodeMsg：

package com.zq.springboot01.result;
    
    public class CodeMsg {
     
        private int code;
        private String msg;
     
        //通用的错误码
        public static CodeMsg SUCCESS = new CodeMsg(200, "success");
        public static CodeMsg SERVER_ERROR = new CodeMsg(500, "服务端异常");
        public static CodeMsg BIND_ERROR = new CodeMsg(500101, "参数校验异常：%s");
        public static CodeMsg REQUEST_ILLEGAL = new CodeMsg(500102, "请求非法");
        public static CodeMsg ACCESS_LIMIT_REACHED = new CodeMsg(500104, "访问太频繁！");
        //登录模块5002XX
        public static CodeMsg SESSION_ERROR = new CodeMsg(500210, "Session不存在或者已经失效");
        public static CodeMsg PASSWORD_EMPTY = new CodeMsg(500211, "登录密码不能为空");
        public static CodeMsg MOBILE_EMPTY = new CodeMsg(500212, "手机号不能为空");
        public static CodeMsg MOBILE_ERROR = new CodeMsg(500213, "手机号格式错误");
        public static CodeMsg MOBILE_NOT_EXIST = new CodeMsg(500214, "手机号不存在");
        public static CodeMsg PASSWORD_ERROR = new CodeMsg(500215, "密码错误");
     
        //商品模块5003XX
     
        //订单模块5004XX
        public static CodeMsg ORDER_NOT_EXIST = new CodeMsg(500400, "订单不存在");
     
        //秒杀模块5005XX
        public static CodeMsg MIAO_SHA_OVER = new CodeMsg(500500, "商品已经秒杀完毕");
        public static CodeMsg REPEATE_MIAOSHA = new CodeMsg(500501, "不能重复秒杀");
        public static CodeMsg MIAOSHA_FAIL = new CodeMsg(500502, "秒杀失败");
     
        private CodeMsg() {
        }
     
        private CodeMsg(int code, String msg) {
            this.code = code;
            this.msg = msg;
        }
     
        public int getCode() {
            return code;
        }
     
        public void setCode(int code) {
            this.code = code;
        }
     
        public String getMsg() {
            return msg;
        }
     
        public void setMsg(String msg) {
            this.msg = msg;
        }
     
        public CodeMsg fillArgs(Object... args) {
            int code = this.code;
            String message = String.format(this.msg, args);
            return new CodeMsg(code, message);
        }
     
        @Override
        public String toString() {
            return "CodeMsg [code=" + code + ", msg=" + msg + "]";
        }
    }

如果我们这样写了之后就是响应类就不用写的那么复杂以增加为例，就会变成：  
![614364f273c243b2a21c67f03c3c3ec5.png][]

**总结一下响应封装类就是：集中管理我们在响应时处理的结果**

[b6cec81d5d074cc9897583bfc3e24ecd.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/01ee65da6c6847b8abc327b25326078e.jpeg
[69592c77ebdb49bb99729cd6ffb98370.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/d145d87c1c1946dabf60414441a782ab.png
[248b6bf3e3714c5c9034026aa292c848.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/c57593b47b8241b79efe1f47308558e0.png
[1caeea8886c24f80af6fbc6e0430e5ee.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/2cd38c8fccd04decb8d84cd5b6c51e1e.png
[cb01a49059974273b20598468ec5e9f7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/8c46830f991a4fa684466a4780f9c946.png
[069ed5453f08472ea7b037479b37036b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/decdda55183f42bfafd7eaea4cb19672.png
[f60bedc4318c4904984592ad720a1a25.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/3726361a5e3743fcb62e47bb7653aec0.png
[d48f2947d87848ccad98ad44a7b12854.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/f03e5087f9734867a2a4975fb6c223c3.png
[02e8ce4492444515b63a18be69b821fb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/68fe45e40fb942cf8d5c97335e5a404b.png
[54c1f478d9f3439d9b459ea0eb0fe66b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/0b6f670ffe1e438384262c35b46c4e06.png
[d9277e486a3e4f2dacbd6b42b0c8d400.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/7eb7be8916c746908da51cf4767c8ba9.png
[83410ea9da3a488c839885bb7df4c0a9.png]: https://img-blog.csdnimg.cn/83410ea9da3a488c839885bb7df4c0a9.png
[4a99744f19684837812567bd50ff582d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/5b10ed9710b14718bd258a89b8abc824.png
[39649bcbde8e4ac88e43cff6b096096f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/195985ed9ad84c5795f4c66a6e249f6f.png
[24003724629846268487d61b9479601a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/649691d5213546aca18ba35e389f3d4e.png
[47fe9b715735465b9f2feda6f176fda8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/32f7562007da4dc1a72b5fd8c86ac841.png
[48c002382f594b7fa5bda3c0925292f9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/f9d021a59fd0470883664990accf83fc.png
[1da7cdf4e78949298146a23876bcca61.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/698ee6689fc04b9c810c802c1cadc751.png
[26c549a102074c76a9b5b0b49d4c4763.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/dfe3e08b8a6245e983116972317836da.png
[6bd6e7e4b2894ad9b895830165664a9d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/6a33f5545af64d529f1dd90476ad3496.png
[614364f273c243b2a21c67f03c3c3ec5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/2bd39f08f5e940ea9e0246b11921ffff.png