AI 助理
文档备案控制台
开发者社区 数据库 文章 正文

还不会用springboot写接口？快看这里，手把手操作，一发入魂~

2022-05-04 1267
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 还不会用springboot写接口？快看这里，手把手操作，一发入魂~

1、springboot简介


Spring Boot 可以轻松创建可以“直接运行”的独立的、生产级的基于 Spring 的应用程序。


特征


创建独立的 Spring 应用程序

直接嵌入 Tomcat、Jetty 或 Undertow（无需部署 WAR 文件）

提供强壮的“入门”依赖项以简化您的构建配置

尽可能自动配置 Spring 和第三方中间件

提供生产就绪功能，例如指标、健康检查和外部化配置

完全无需代码生成，无需 XML 配置


2、新建springboot web项目


按以下步骤依次操作


image.png

image.png

image.png


初始化项目完整的结构


image.png


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


image.png


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. 创建数据源


image.png


  1. 配置连接信息


image.png


  1. 执行建表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='菜单表';


image.png


  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);


image.png


image.png


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


由于使用mybatis plus框架，帮我们简化了很多简单的增删改查，所以这里的service和mapper代码就写得很清爽，但也可实现咱们的功能


6、接口测试


6.1 启动项目


image.png


6.2 通过knife4j测试接口


  1. 在浏览器打开测试地址


http://127.0.0.1:8888/doc.html#/home


image.png


  1. 测试列表接口


image.png


curl -X POST -H  "Accept:*/*" -H  "Content-Type:application/json" -d "{\"currentPage\":1,\"pageSize\":20}" "http://127.0.0.1:8888/menus/list"


  1. 测试新增接口


image.png


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"


查看是否新增成功


image.png


4.测试详情接口


image.png


curl -X POST -H  "Accept:*/*" -H  "Content-Type:application/json" -d "{\"id\":1502651873142775800}" "http://127.0.0.1:8888/menus/getOne"


5.测试删除接口


image.png


curl -X POST -H  "Accept:*/*" -H  "Content-Type:application/json" -d "{\"id\":1502651873142775800}" "http://127.0.0.1:8888/menus/delete"


查看是否删除成功


image.png


7、源码地址


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


8、总结


这篇只是springboot入门项目，后面咱们可根据该项目逐步开发更多高深的企业级功能，包括starter的封装、数据操作变更日志、响应体包装等，欢迎老铁们追更。
文章标签：
云数据库 RDS MySQL 版
Java
前端开发
SQL
关系型数据库
MySQL
Spring
mybatis
数据库
开发者
数据库连接
相关实践学习
每个IT人都想学的“Web应用上云经典架构”实战
本实验从Web应用上云这个最基本的、最普遍的需求出发，帮助IT从业者们通过“阿里云Web应用上云解决方案”，了解一个企业级Web应用上云的常见架构，了解如何构建一个高可用、可扩展的企业级应用架构。
MySQL数据库入门学习
本课程通过最流行的开源数据库MySQL带你了解数据库的世界。 &nbsp; 相关的阿里云产品：云数据库RDS MySQL 版 阿里云关系型数据库RDS（Relational Database Service）是一种稳定可靠、可弹性伸缩的在线数据库服务，提供容灾、备份、恢复、迁移等方面的全套解决方案，彻底解决数据库运维的烦恼。 了解产品详情:&nbsp;https://www.aliyun.com/product/rds/mysql&nbsp;
隐-风
目录
相关文章
木流牛马
|
11月前
|
安全 NoSQL Java
SpringBoot接口安全：限流、重放攻击、签名机制分析
本文介绍如何在Spring Boot中实现API安全机制，涵盖签名验证、防重放攻击和限流三大核心。通过自定义注解与拦截器，结合Redis，构建轻量级、可扩展的安全防护方案，适用于B2B接口与系统集成。
木流牛马
1314 3
啦啦啦191
|
Java API 网络架构
基于 Spring Boot 框架开发 REST API 接口实践指南
本文详解基于Spring Boot 3.x构建REST API的完整开发流程，涵盖环境搭建、领域建模、响应式编程、安全控制、容器化部署及性能优化等关键环节，助力开发者打造高效稳定的后端服务。
啦啦啦191
1558 1
智物科技库
|
算法 网络协议 Java
Spring Boot 的接口限流算法
本文介绍了高并发系统中流量控制的重要性及常见的限流算法。首先讲解了简单的计数器法，其通过设置时间窗口内的请求数限制来控制流量，但存在临界问题。接着介绍了滑动窗口算法，通过将时间窗口划分为多个格子，提高了统计精度并缓解了临界问题。随后详细描述了漏桶算法和令牌桶算法，前者以固定速率处理请求，后者允许一定程度的流量突发，更符合实际需求。最后对比了各算法的特点与适用场景，指出选择合适的算法需根据具体情况进行分析。
智物科技库
1074 56
Spring Boot 的接口限流算法
蓝易云
|
监控 Java Spring
SpringBoot：SpringBoot通过注解监测Controller接口
本文详细介绍了如何通过Spring Boot注解监测Controller接口，包括自定义注解、AOP切面的创建和使用以及具体的示例代码。通过这种方式，可以方便地在Controller方法执行前后添加日志记录、性能监控和异常处理逻辑，而无需修改方法本身的代码。这种方法不仅提高了代码的可维护性，还增强了系统的监控能力。希望本文能帮助您更好地理解和应用Spring Boot中的注解监测技术。
蓝易云
626 16
潇洒洒
|
Java 开发者 Spring
精通SpringBoot：16个扩展接口精讲
【10月更文挑战第16天】 SpringBoot以其简化的配置和强大的扩展性，成为了Java开发者的首选框架之一。SpringBoot提供了一系列的扩展接口，使得开发者能够灵活地定制和扩展应用的行为。掌握这些扩展接口，能够帮助我们写出更加优雅和高效的代码。本文将详细介绍16个SpringBoot的扩展接口，并探讨它们在实际开发中的应用。
潇洒洒
599 1
最好zzz
|
监控 Java 开发者
掌握SpringBoot扩展接口：提升代码优雅度的16个技巧
【10月更文挑战第20天】 SpringBoot以其简化配置和快速开发而受到开发者的青睐。除了基本的CRUD操作外，SpringBoot还提供了丰富的扩展接口，让我们能够更灵活地定制和扩展应用。以下是16个常用的SpringBoot扩展接口，掌握它们将帮助你写出更加优雅的代码。
最好zzz
664 0
我是快乐的嘟嘟
|
存储 安全 Java
在 Spring Boot 中使用 JWT 进行接口加密解密的方法
【10月更文挑战第18天】
我是快乐的嘟嘟
1617 63
我是快乐的嘟嘟
|
存储 算法 安全
SpringBoot 接口加密解密实现
【10月更文挑战第18天】
我是快乐的嘟嘟
1672 55
蓝易云
|
存储 NoSQL Java
Spring Boot项目中使用Redis实现接口幂等性的方案
通过上述方法，可以有效地在Spring Boot项目中利用Redis实现接口幂等性，既保证了接口操作的安全性，又提高了系统的可靠性。
蓝易云
862 1
杀死一只知更鸟debug
|
SQL JSON Java
springboot 如何编写增删改查后端接口，小白极速入门，附完整代码
本文为Spring Boot增删改查接口的小白入门教程，介绍了项目的构建、配置YML文件、代码编写（包括实体类、Mapper接口、Mapper.xml、Service和Controller）以及使用Postman进行接口测试的方法。同时提供了SQL代码和完整代码的下载链接。
杀死一只知更鸟debug
4577 1
springboot 如何编写增删改查后端接口，小白极速入门，附完整代码

热门文章

最新文章

  • 1
    如何在SpringBoot中集成JWT(JSON Web Token)鉴权
  • 2
    基于springboot的助农管理系统的设计与实现
  • 3
    MinIO【部署 01】MinIO安装及SpringBoot集成简单测试
  • 4
    windows解决SpringBoot启动时：APPLICATION FAILED TO START
  • 5
    一个基于 Spring Boot 的项目骨架，少造轮子！
  • 6
    spring boot 2以上版本整合mybatis
  • 7
    Jenkins Pipeline 流水线方式部署 SpringBoot 项目2
  • 8
    spring boot 集成websocket与shiro的坑
  • 9
    这是我见过SpringBoot版的最好的ERP系统，自带进销存+财务+生产功能，拿来即用（附项目地址）
  • 10
    SpringBoot从入门到精通（二十五）搞懂自定义系统配置
  • 1
    SpringBoot启动时连接Redis报错：ERR This instance has cluster support disabled - 如何解决？
    745
  • 2
    基于springboot的大学生兼职系统
    612
  • 3
    基于springboot的宠物领养系统
    791
  • 4
    2025基于springboot的校车预定全流程管理系统
    802
  • 5
    基于springboot的美食城服务管理系统
    541
  • 6
    基于springboot的高校运动会系统
    499
  • 7
    【Spring Boot实战】EasyPoi神技：一篇搞定“一对多+图片”导入！
    2237
  • 8
    《深入理解Spring》 Spring Boot——约定优于配置的革命者
    1191
  • 9
    《深入理解Spring》：Spring、Spring MVC与Spring Boot的深度解析
    2288
  • 10
    基于springboot的网咖网吧管理系统
    608

    • 相关课程

    更多
  • 微服务+全栈在线教育实战项目演练（SpringCloud Alibaba+SpringBoot）
  • SpringBoot实战教程
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Springboot项目云开发快速迁移

    • 相关电子书

    更多
  • 低代码开发师（初级）实战教程
  • 冬季实战营第三期：MySQL数据库进阶实战
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    一条命令迁移，帮你实现 OpenClaw 与 Hermes Agent 记忆互通！