還不會用springboot寫介面？快看這裡，手把手操作，一發入魂~

隱風發表於2022-03-16
Spring Boot

1、springboot簡介

Spring Boot 可以輕鬆建立可以“直接執行”的獨立的、生產級的基於 Spring 的應用程式。

特徵

建立獨立的 Spring 應用程式

直接嵌入 Tomcat、Jetty 或 Undertow（無需部署 WAR 檔案）

提供強壯的“入門”依賴項以簡化您的構建配置

儘可能自動配置 Spring 和第三方中介軟體

提供生產就緒功能，例如指標、健康檢查和外部化配置

完全無需程式碼生成，無需 XML 配置

2、新建springboot web專案

按以下步驟依次操作
在這裡插入圖片描述
在這裡插入圖片描述
在這裡插入圖片描述
初始化專案完整的結構
在這裡插入圖片描述

3、基本配置

3.1 引入相關依賴

mysql連線依賴

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>

mybatis-plus

MyBatis-Plus (opens new window)（簡稱 MP）是一個 MyBatis (opens new window)的增強工具，在 MyBatis 的基礎上只做增強不做改變，為簡化開發、提高效率而生。

特性

無侵入：只做增強不做改變，引入它不會對現有工程產生影響，如絲般順滑
損耗小：啟動即會自動注入基本 CURD，效能基本無損耗，直接物件導向操作
強大的 CRUD 操作：內建通用 Mapper、通用 Service，僅僅通過少量配置即可實現單表大部分 CRUD 操作，更有強大的條件構造器，滿足各類使用需求
支援 Lambda 形式呼叫：通過 Lambda 表示式，方便的編寫各類查詢條件，無需再擔心欄位寫錯
支援主鍵自動生成：支援多達 4 種主鍵策略（內含分散式唯一 ID 生成器 - Sequence），可自由配置，完美解決主鍵問題
支援 ActiveRecord 模式：支援 ActiveRecord 形式呼叫，實體類只需繼承 Model 類即可進行強大的 CRUD 操作
支援自定義全域性通用操作：支援全域性通用方法注入（ Write once, use anywhere ）
內建程式碼生成器：採用程式碼或者 Maven 外掛可快速生成 Mapper 、 Model 、 Service 、 Controller 層程式碼，支援模板引擎，更有超多自定義配置等您來使用
內建分頁外掛：基於 MyBatis 物理分頁，開發者無需關心具體操作，配置好外掛之後，寫分頁等同於普通 List 查詢
分頁外掛支援多種資料庫：支援 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多種資料庫
內建效能分析外掛：可輸出 SQL 語句以及其執行時間，建議開發測試時啟用該功能，能快速揪出慢查詢
內建全域性攔截外掛：提供全表 delete 、 update 操作智慧分析阻斷，也可自定義攔截規則，預防誤操作

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.1</version>
</dependency>

knife4j

Knife4j的前身是swagger-bootstrap-ui,前身swagger-bootstrap-ui是一個純swagger-ui的ui皮膚專案。
一開始專案初衷是為了寫一個增強版本的swagger的前端ui,但是隨著專案的發展,面對越來越多的個性化需求,不得不編寫後端Java程式碼以滿足新的需求,在swagger-bootstrap-ui的1.8.5~1.9.6版本之間,採用的是後端Java程式碼和Ui都混合在一個Jar包裡面的方式提供給開發者使用.這種方式雖說對於整合swagger來說很方便,只需要引入jar包即可,但是在微服務架構下顯得有些臃腫。
因此,專案正式更名為knife4j,取名knife4j是希望她能像一把匕首一樣小巧,輕量,並且功能強悍,更名也是希望把她做成一個為Swagger介面文件服務的通用性解決方案,不僅僅只是專注於前端Ui前端.

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

完整pom.xml檔案

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.yinfeng</groupId>
    <artifactId>test</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>test</name>
    <description>test</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.1</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

3.2 完成application.yml檔案配置

server:
  # 服務埠
  port: 8888
spring:
  application:
    name: yinfeng-test
  # 資料庫相關配置
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/test?useSSL=false&serverTimezone=UTC&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    username: root
    password: yinfeng
    driver-class-name: com.mysql.cj.jdbc.Driver

在這裡插入圖片描述

3.3 配置knife4j

/**
 * @author yinfeng
 * @description knife4j配置
 * @since 2022/3/12 21:49
 */
@Configuration
@EnableSwagger2
public class Knife4jConfig {
    @Bean
    public Docket buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder().title("隱風 API文件").version("1.0").build())
                .select()
                .apis(RequestHandlerSelectors
                        .basePackage("com.yinfeng.test.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

/**
 * @author yinfeng
 * @description web配置
 * @since 2022/3/12 21:57
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

}

3.4 配置mybatis plus外掛

/**
 * @author yinfeng
 * @description Mybatis plus配置
 * @since 2022/3/12 22:29
 */
@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 加入分頁外掛
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
        return interceptor;
    }
}

4、建立測試表

4.1 連線資料庫

可以通過idea的資料庫工具直接連線資料庫

  1. 建立資料來源
    在這裡插入圖片描述

  2. 配置連線資訊
    在這裡插入圖片描述

  3. 執行建表sql

CREATE TABLE `menus` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '選單id',
  `level` int(11) NOT NULL DEFAULT '1' COMMENT '選單等級',
  `name` varchar(11) NOT NULL DEFAULT '' COMMENT '選單名',
  `note` varchar(500) DEFAULT NULL COMMENT '備註',
  `create_time` datetime NOT NULL COMMENT '建立時間',
  `update_time` datetime NOT NULL COMMENT '更新時間',
  `deleted` tinyint(4) NOT NULL DEFAULT '0' COMMENT '刪除標誌',
  PRIMARY KEY (`id`) USING BTREE,
  UNIQUE KEY `menus_id_uindex` (`id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='選單表';

在這裡插入圖片描述

  1. 建立測試資料
INSERT INTO `menus` (`id`, `level`, `name`, `update_time`, `note`, `create_time`, `deleted`) VALUES (1, 1, '首頁', '2021-08-22 13:44:51', '首頁', '2021-08-22 13:44:51', 0);
INSERT INTO `menus` (`id`, `level`, `name`, `update_time`, `note`, `create_time`, `deleted`) VALUES (1444693273867198466, 1, '科室管理', '2021-10-03 15:58:38', '科室管理科室管理', '2021-10-03 15:58:16', 0);

在這裡插入圖片描述
在這裡插入圖片描述

5、介面開發

5.1 建立選單表對應的實體類

/**
 * @author yinfeng
 * @description 選單表
 * @TableName menus
 * @since 2022年3月12日 下午9:40:48
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@ApiModel("選單表")
@TableName("menus")
public class Menus {

    /**
     * 選單id
     */
    @TableId(type = IdType.ASSIGN_ID)
    @JsonSerialize(using = ToStringSerializer.class)
    @ApiModelProperty(value = "選單id", example = "")
    private Long id;

    /**
     * 選單等級
     */
    @TableField("level")
    @ApiModelProperty(value = "選單等級", example = "")
    private Integer level;

    /**
     * 選單名
     */
    @TableField("name")
    @ApiModelProperty(value = "選單名", example = "")
    private String name;

    /**
     * 備註
     */
    @TableField("note")
    @ApiModelProperty(value = "備註", example = "")
    private String note;

    /**
     * 建立時間
     */
    @TableField(value = "create_time", fill = FieldFill.INSERT)
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    @ApiModelProperty(value = "建立時間", example = "")
    private Date createTime;

    /**
     * 更新時間
     */
    @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    @ApiModelProperty(value = "更新時間", example = "")
    private Date updateTime;

    /**
     * 刪除標誌
     */
    @TableField("deleted")
    @TableLogic
    @JsonIgnore
    @ApiModelProperty(value = "刪除標誌", example = "")
    private Integer deleted;

    /**
     * 當前頁
     */
    @ApiModelProperty(value = "當前頁", example = "1")
    @TableField(exist = false)
    private Integer currentPage;

    /**
     * 分頁頁數
     */
    @ApiModelProperty(value = "分頁頁數", example = "20")
    @TableField(exist = false)
    private Integer pageSize;
}

5.2 建立選單表對應的controller

包含基本的增刪改查介面

/**
 * @author yinfeng
 * @since 2022年3月12日 下午9:40:48
 * @description 選單表
 */
@Api(tags = "選單表")
@RestController
@RequestMapping("/menus")
public class MenusController{

    @Resource
    private MenusService menusService;

    @PostMapping("/list")
    @ApiOperation(value = "列表", notes = "選單表")
    public IPage<Menus> list(@RequestBody Menus menus) {
        return menusService.list(menus);
    }

    @PostMapping("/getOne")
    @ApiOperation(value = "單個查詢", notes = "選單表")
    public Menus getOne(@RequestBody Menus menus) {
        return menusService.getOne(menus);
    }

    @PostMapping("/save")
    @ApiOperation(value = "新增或編輯", notes = "選單表")
    public boolean save(@RequestBody Menus menus) {
        return menusService.saveOrUpdate(menus);
    }

    @PostMapping("/delete")
    @ApiOperation(value = "刪除", notes = "選單表")
    public boolean delete(@RequestBody Menus menus) {
        return menusService.delete(menus);
    }

}

5.3 建立選單表對應的service

/**
 * @author yinfeng
 * @since 2022年3月12日 下午9:40:48
 * @description 選單表
 * @TableName menus
 */
public interface MenusService extends IService<Menus> {

    /**
     * 查詢列表
     *
     * @param vo vo
     * @return IPage<Menus>
     */
    IPage<Menus> list(Menus vo);

    /**
     * 單個查詢
     *
     * @param vo vo
     * @return Menus
     */
    Menus getOne(Menus vo);

    /**
     * 儲存
     *
     * @param vo vo
     * @return 是否儲存成功
     */
    @Override
    boolean saveOrUpdate(Menus vo);

    /**
     * 刪除
     *
     * @param vo vo
     * @return 是否刪除成功
     */
    boolean delete(Menus vo);

}


/**
 * @author yinfeng
 * @since 2022年3月12日 下午9:40:48
 * @description 選單表
 * @TableName menus
 */
@Service
public class MenusServiceImpl extends ServiceImpl<MenusMapper, Menus>
    implements MenusService{

    @Override
    public IPage<Menus> list(Menus vo){
        final QueryWrapper<Menus> wrapper = new QueryWrapper<>();
        wrapper.eq(ObjectUtils.isNotEmpty(vo.getId()), "id", vo.getId());
        return super.page(new Page<>(vo.getCurrentPage(), vo.getPageSize()), wrapper);
    }

    @Override
    public Menus getOne(Menus vo){
        final QueryWrapper<Menus> wrapper = new QueryWrapper<>();
        wrapper.eq(ObjectUtils.allNotNull(vo.getId()), "id", vo.getId());
        return super.getOne(wrapper);
    }

    @Override
    public boolean saveOrUpdate(Menus vo) {
        return super.saveOrUpdate(vo);
    }

    @Override
    public boolean delete(Menus vo) {
        final QueryWrapper<Menus> wrapper = new QueryWrapper<>();
        wrapper.eq(ObjectUtils.allNotNull(vo.getId()), "id", vo.getId());
        return super.remove(wrapper);
    }

}

5.3 建立選單表對應的mapper，相當於直接運算元據庫的類

/**
* @author yinfeng
* @since 2022年3月12日 下午9:40:48
* @description 選單表
* @TableName menus
*/
@Mapper
public interface MenusMapper extends BaseMapper<Menus> {
}

由於使用mybatis plus框架，幫我們簡化了很多簡單的增刪改查，所以這裡的service和mapper程式碼就寫得很清爽，但也可實現我們們的功能

6、介面測試

6.1 啟動專案

在這裡插入圖片描述

6.2 通過knife4j測試介面

  1. 在瀏覽器開啟測試地址
http://127.0.0.1:8888/doc.html#/home

在這裡插入圖片描述

  1. 測試列表介面

在這裡插入圖片描述

curl -X POST -H  "Accept:*/*" -H  "Content-Type:application/json" -d "{\"currentPage\":1,\"pageSize\":20}" "http://127.0.0.1:8888/menus/list"
  1. 測試新增介面
    在這裡插入圖片描述
curl -X POST -H  "Accept:*/*" -H  "Content-Type:application/json" -d "{\"createTime\":\"2021-10-03 15:58:38\",\"level\":2,\"name\":\"使用者管理\",\"note\":\"使用者管理操作\",\"updateTime\":\"2021-10-03 15:58:38\"}" "http://127.0.0.1:8888/menus/save"

檢視是否新增成功
在這裡插入圖片描述

  1. 測試詳情介面
    在這裡插入圖片描述
curl -X POST -H  "Accept:*/*" -H  "Content-Type:application/json" -d "{\"id\":1502651873142775800}" "http://127.0.0.1:8888/menus/getOne"
  1. 測試刪除介面
    在這裡插入圖片描述
curl -X POST -H  "Accept:*/*" -H  "Content-Type:application/json" -d "{\"id\":1502651873142775800}" "http://127.0.0.1:8888/menus/delete"

檢視是否刪除成功
在這裡插入圖片描述

7、原始碼地址

https://gitee.com/yinfeng-code/test.git

8、總結

這篇只是springboot入門專案，後面我們們可根據該專案逐步開發更多高深的企業級功能，包括starter的封裝、資料操作變更日誌、響應體包裝等，歡迎老鐵們追更。

肝文不易，最後希望老鐵們給波三連（點贊、收藏、評論）加關注，非常感謝大家支援~~

相關文章