快速入门Springboot

发布于：2022-11-27 ⋅ 阅读:(451) ⋅ 点赞:(0)

目录

一，简介

二，入门

创建springboot项目

​编辑

 springboot项目目录介绍

下载properties与yml的文件转换插件

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

原始用法

Eolink

 统一响应类

Result

错误编码类

CodeMsg

使用响应封装类

 总结

一，简介

Spring Boot它本身并不提供Spring框架的核心特性以及扩展功能，只是用于快速、敏捷地开发新一代基于Spring框架的应用程序。
也就是说，它并不是用来替代Spring的解决方案，而是和Spring框架紧密结合用于提升Spring开发者体验的工具

同时它集成了大量常用的第三方库配置（例如Jackson, JDBC, Mongo, Redis, Mail等等），
Spring Boot应用中这些第三方库几乎可以零配置的开箱即用（out-of-the-box），大部分的Spring Boot应用都
只需要非常少量的配置代码，开发者能够更加专注于业务逻辑

注1：敏捷式开发

注2：spring boot其实不是什么新的框架，它默认配置了很多框架的使用方式， 就像maven整合了所有的jar包，spring boot整合了所有的框架

注3：基于Spring框架的一站式解决方案

二，入门

创建springboot项目

58cc2d506dc544d6a5106f4e0724f334.png

3af4231415d047c3bdf0a7881927d679.png

2d62994586ee424182f027dc184152ad.png

 本期我们是要整合SpringMV，所以我们勾选

spring Web 

f2b48fee46ee4b0cbd0660ea0df2be8a.png

选择项目地址，连续next即可

d3556f23d66c4c779c0c05e27115b9fc.png

 测试springboot项目，

注：springboot不需要配置tomcat，在它的pom文件中已有内置tomcat

 执行该类中的main方法即可运行该项目，控制台中会出现可访问的端口以及路径，前提是你自己编写了方法16d5d076e19b405fa8d8f629e015c307.png

 小刘的测试方法：

a02e5151afc745f8a62adeb9e483d883.png

 输入端口号以及地址进行访问,返回方法中的返回值

60d0aee0b5944eeaaf8224eaa5f10a40.png

df6b7a1bbe8e4b77afef845c81c178df.png

 springboot项目目录介绍

8b6e5a0c834b4ba383816353d391cac9.png

 application.properties 是Springboot中唯二的配置文件，还有一个配置文件在后期微服务中会讲到， 此后在项目中运用到springmvc和mybaits等框架的配置都是配置在此文件里，但是我们一般不会在此文件存放太多东西，而且影响查看，所以需要我们的下一步

server.servlet.context-path=/(项目名之类的) （此配置可以让你的访问项目的路径后面不为空，默认为空）

fd5ba4297d8d43c18349a19451913b84.png

下载properties与yml的文件转换插件

5a0cafae534846dfba54a9966ba87cf7.png

 选中配置文件右键d64196e3f77f4400a3a987291dc0714e.png

 发生改变，树状结构

7e5420f7f37e43fabf85919ee0dab092.png

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

原始用法

package com.ycx.springboot01.demo;
 
import jdk.nashorn.internal.objects.annotations.Constructor;
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 ljj
 * @site www.xiaomage.com
 * @company
 * @create  2022-11-03 23:32
 */

@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;
}

启动项目，输入访问地址：

91bc4dcfd6a84a6c91ef8f0c9b8f7614.png

 当我们修改了增删改查方法上面的注解之后

package com.ljj.springboot01.demo;

import jdk.nashorn.internal.objects.annotations.Constructor;
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 ljj
 * @site www.xiaomage.com
 * @company
 * @create  2022-11-03 23:32
 */

@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(Book book){
        System.out.println(book);
        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("/delete")
    public Map delete(int bid){
        System.out.println(bid);
        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;


}

a40143295f4341b6aed2325220c5a7f5.png

此时我们的测试就需要借助软件

Eolink

f13023480ee64a28a7055a3526383c61.png

可以更细粒度的调测后台数据的接口

2439beb077594d3985900a6949b268e9.png

idea里控制台的响应

66570c4969dd4e6d8b806dd356a0e8ae.png

b6238120533e4171ad95bbffcbc6dd40.png

 控制台响应

eee638f239284e7aaffec221eeb50db4.png

 统一响应类

Result

package com.ljj.springboot01.result;

public class Result<T> {
 
    private int code;
    private String msg;
    //因为返回的数据不知道是什么类型，所以定义一个泛型
    private T data;
    private long total;
//    private CodeMsg codeMsg;

    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.ljj.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 + "]";
    }
}

使用响应封装类

package com.ljj.springboot01.demo;

import com.ljj.springboot01.result.CodeMsg;
import com.ljj.springboot01.result.Result;
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 ljj
 * @site www.xiaomage.com
 * @company
 * @create  2022-11-03 23:32
 */

@RestController
@RequestMapping("/book2")
public class BookController2 {
    @GetMapping("/list")
    public Result 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 Result.ok(200,"查询成功",books,222);
    }

    @PutMapping("/add")
    public Result add(Book book){
        System.out.println(book);
        int id = book.getId();
        if(id == 0){
            return Result.error(CodeMsg.BIND_ERROR.fillArgs("id未传递"));
        }
        return Result.ok(200,"新增成功");
    }

    @PostMapping("/update")
    public Result update(){
        Map map = new HashMap();
        return Result.ok(200,"修改成功");
    }


    @DeleteMapping("/delete")
    public Result delete(int bid){
        System.out.println(bid);
        Map map = new HashMap();
        return Result.ok(200,"删除成功");
    }

    @RequestMapping("/load")
    public Result load(){
        return Result.ok(200,"加载成功",new Book(5,"西游记"));
    }
}

使用工具测试add方法

f9ef6a71dbdb4028814619508cc6de56.png

 传递了id与name值

b96c721c7f684b899fa89ce1723ebeb5.png

 idea控制台响应

4e546b8523074cef93d2fc45759005e9.png

 传递id为0

c277bb5a90ce4d0dbe53f6a980ca7db1.png

 或者使用默认的错误码信息，当传递的id为0时

 2c27d353370b4230bdbdb5f0fd92691e.png

 对应错误编码类中的一个可能发生的异常编号c250f4f9f04942198879d9c9a8d35447.png

 测试结果

d20a65c70eda4256bac00b49a0187a46.png

 总结

使用统一的响应封装类以及错误编码类，这个是一种良好的编码习惯！

统一的响应类也不需要我们在方法中编写太多重复的内容，比较简便

当我们把所有在项目中可能出现的异常全部存放在错误编码类中，我们只需要在可能出现异常的地方调用即可，而不用每一处都重新写一个，改的时候也要一个一个改，而是可以实现改一处处处改的效果，这样编码更有利于效率的提升。

 

本文含有隐藏内容，请 开通VIP 后查看

网站公告

今日签到

点亮在社区的每一天
去签到

热门文章

最新发布