第一步：springboot初学项目mybatisx搭建三层架构并通过swagger文档完成测试

已于 2024-08-01 12:44:21 修改
阅读量838 收藏 27
点赞数 18
分类专栏： spring项目入门 文章标签： spring boot 后端 java
于 2024-08-01 10:35:02 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_63674106/article/details/140831159
版权

编者著：

在学校的实训过程中一直在做的前端方面的活，后端的了解不深入，为此，重新学习，参照实训期间已经完成的项目，将后端从零开始进行操作。

项目初建

springinitial选项选择maven，勾选依赖

一些常用的依赖选项：

  1. Spring Data JPA：如果项目需要与数据库进行交互，尤其是使用关系型数据库，可以勾选Spring Data JPA。它提供了方便的数据访问层开发和ORM功能。

  2. Spring Security：如果项目涉及用户认证和授权，可以勾选Spring Security。它提供了一整套安全功能，包括登录、注册、角色管理等。

  3. Spring Boot DevTools：如果希望在开发时提高效率，可以勾选Spring Boot DevTools。它提供了自动重启、LiveReload等开发者工具。

  4. Spring Boot Actuator：用于监控和管理应用，提供健康检查、监控指标等功能。

  5. Spring Configuration Processor：有助于在IDE中获得配置文件的自动补全。

  6. Lombok：简化Java代码，尤其是简化getter/setter、构造函数等常见代码的编写。

  7. Spring Cloud：如果项目需要微服务架构或者需要使用分布式系统功能，如服务发现、配置管理等，可以勾选相关的Spring Cloud依赖。

  8. Spring Kafka/RabbitMQ：如果项目需要消息队列功能，可以根据需要勾选Spring for Apache Kafka或Spring for RabbitMQ。

具体选择哪些依赖，取决于你的项目需求。一般来说，一个最基本的前后端分离项目需要Spring Web、Spring Data JPA和Spring Security。其他依赖可以根据具体功能需求逐步添加。

勾选完毕后，完成创建。

数据库连接

点击设置进入配置，本地已有数据库，配置完成

在application中，进行数据库配置

配置完毕后在pom中添加依赖

swagger依赖用knife4j ui，

mybatispuls所需依赖

<dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.7</version> <!-- 请使用最新版本 -->
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.5.1</version> <!-- 请使用最新版本 -->
        </dependency>
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.3</version>
        </dependency>

mybatis生成目录

通过mybatisx建表生成实体类，service以及mapper结构，自行创建controller

完成三层的代码编写

mapper

以注解方式的实现为例：


@Mapper
public interface AdminMapper extends BaseMapper<Admin> {
    @Select("SELECT * FROM admin WHERE id = #{id}")
    Admin findById(@Param("id") int id);

    @Insert("INSERT INTO admin(name, password) VALUES(#{name}, #{password})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    int insert(Admin admin);

    @Select("SELECT * FROM admin")
    List<Admin> findAll();


    @Update("UPDATE admin SET name=#{name}, password=#{password} WHERE id=#{id}")
    int update(Admin admin);

    @Delete("DELETE FROM admin WHERE id = #{id}")
    int delete(@Param("id") int id);
}

对mapper理解

在MyBatis中，`#{}` 用于标记占位符，将其替换为传入参数的具体值。当你使用 `#{name}` 这样的占位符时，MyBatis会根据方法的参数或参数对象的属性名来匹配相应的值。
 

 @Select("SELECT * FROM admin WHERE id = #{id}")
    Admin findById(@Param("id") int id);

    @Insert("INSERT INTO admin(name, password) VALUES(#{name}, #{password})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    int insert(Admin admin);

对于一般的直接传入id的情况，通过@Param（“id”），这里的id会被绑定到#{id}上，int id则是个形式参数，负责标记的还是@Param

如何匹配 `#{name}` 和 `#{password}`

1. 传入的参数对象：在这个方法中，`Admin admin` 是一个传入的参数对象。这个对象包含了插入操作所需要的数据属性。

2. `#{}` 占位符的工作原理：
   - MyBatis 会通过反射机制遍历传入的参数对象 `admin`，查找和占位符匹配的属性。
   - 具体来说，当MyBatis看到 `#{name}` 时，它会去查找 `admin` 对象中是否有一个名为 `name` 的属性。
   - 同理，`#{password}` 会查找 `admin` 对象中名为 `password` 的属性。

3. 属性值替换：
   - MyBatis 找到匹配的属性后，就会使用该属性的值替换占位符。例如，`admin` 对象的 `name` 属性值为 "username"，`password` 属性值为 "password"，那么 MyBatis 会将 `#{name}` 替换为 "username"，`#{password}` 替换为 "password"。

4. 生成的SQL语句：
   - 替换完成后，最终的SQL语句可能类似于：

     INSERT INTO admin(name, password) VALUES('username', 'password')
 

总结

`#{name}` 和 `#{password}` 是MyBatis的占位符，用于在SQL语句中动态替换成方法参数的实际值。MyBatis通过反射机制自动识别并替换这些占位符的值。当方法传入一个对象时，如 `Admin admin`，MyBatis会根据对象的属性名称匹配占位符，并将属性值注入到SQL语句中。这样就实现了参数和SQL语句之间的动态绑定。

service


public interface AdminService {
    Admin findById(int id);
    List<Admin> findAll();
    int insert(Admin admin);
    int update(Admin admin);
    int delete(int id);
}

serviceimpl


@Service
public class AdminServiceImpl implements AdminService {

   
    private AdminMapper adminMapper;
    @Autowired
    public AdminServiceImpl(AdminMapper adminMapper){
        this.adminMapper=adminMapper;
    }
    @Override
    public Admin findById(int id) {
        return adminMapper.findById(id);
    }

    @Override
    public List<Admin> findAll() {
        return adminMapper.findAll();
    }

    @Override
    public int insert(Admin admin) {
        return adminMapper.insert(admin);
    }

    @Override
    public int update(Admin admin) {
        return adminMapper.update(admin);
    }

    @Override
    public int delete(int id) {
        return adminMapper.delete(id);
    }
}

controller


@RestController
@RequestMapping("/admin")
@Api(tags = "管理员接口")  // Knife4j 标签
public class AdminController {

    private final AdminService adminService;

    @Autowired
    public AdminController(AdminService adminService) {
        this.adminService = adminService;
    }

    @ApiOperation(value = "根据ID查找管理员", notes = "根据ID查找管理员信息")
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "查找成功"),
            @ApiResponse(code = 404, message = "管理员未找到")
    })
    @GetMapping("/{id}")
    public Admin findById(@PathVariable int id) {
        return adminService.findById(id);
    }

    @ApiOperation(value = "获取所有管理员", notes = "获取所有管理员列表")
    @GetMapping("/list")
    public List<Admin> findAll() {
        return adminService.findAll();
    }

    @ApiOperation(value = "保存新的管理员", notes = "保存新的管理员信息")
    @PostMapping("/save")
    public int save(@RequestBody Admin admin) {
        return adminService.insert(admin);
    }

    @ApiOperation(value = "更新管理员信息", notes = "更新现有管理员的信息")
    @PutMapping("/update")
    public int update(@RequestBody Admin admin) {
        return adminService.update(admin);
    }

    @ApiOperation(value = "删除管理员", notes = "根据ID删除管理员")
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "删除成功"),
            @ApiResponse(code = 404, message = "管理员未找到")
    })
    @DeleteMapping("/delete/{id}")
    public int delete(@PathVariable int id) {
        return adminService.delete(id);
    }
}

@RequestBody用于接收HTTP请求体中的JSON数据

在`POST`、`PUT`、`PATCH`等请求中，数据通常通过请求体发送，尤其是当数据结构复杂时，使用`@RequestBody`是推荐的做法。`@RequestBody`将请求体的数据解析为Java对象，非常适合处理JSON或XML格式的数据。

{
  "name": "John",
  "age": 30
}

@PathVariable用于从URL路径中获取变量。

GET /users/{id}

@RequestParam用于从查询参数中提取数据（通常出现在URL的`?`之后）或表单数据，并将其绑定到方法参数上

GET /search?query=java&sort=desc
@GetMapping("/search")
public List<Result> search(@RequestParam String query, @RequestParam String sort) {
    return searchService.search(query, sort);
}

knife4j注解

  • @Api：定义在类上，表示Controller的标签，通常用于说明该Controller的功能。
  • @ApiOperation：定义在方法上，用于说明该接口的作用和详细描述。
  • @ApiResponse 和 @ApiResponses：定义在方法上，用于说明接口的响应状态和对应的描述信息。

运行配置

设置mapperscan，扫描mapper文件夹下面使用注解的部分

添加mybatis.mapper,完成对xml部分的配置

swaggerconfig


@Configuration
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) // 仅扫描有@ApiOperation注解的方法
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API 文档")
                .description("API 文档描述")
                .version("1.0")
                .build();
    }
}
1. @Configuration 注解
  • 该注解表明这是一个配置类，相当于传统的 Spring XML 配置文件。Spring 会将该类标记为一个配置类并进行管理。
2. createRestApi 方法
  • 这是一个标记为 @Bean 的方法，返回一个 Docket 对象。Docket 是 Swagger 的主要配置对象，用于控制和定制 Swagger 的各项功能。
Docket 配置内容

  • DocumentationType.OAS_30：指定文档类型，这里使用的是 OpenAPI 3.0 规范（OAS 3.0），也即 Swagger 3.0。

  • apiInfo(apiInfo())：设置 API 文档的基本信息，包括标题、描述、版本等。这个信息是通过 apiInfo() 方法生成的 ApiInfo 对象。

  • select()：返回一个 ApiSelectorBuilder 实例，用于控制哪些接口暴露给 Swagger 来生成文档。

  • apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))：仅扫描带有 @ApiOperation 注解的方法。RequestHandlerSelectors.withMethodAnnotation 是一个选择器，用于选择特定的注解方法。

  • build()：构建并返回一个 Docket 实例。

3. apiInfo 方法
  • 该方法返回一个 ApiInfo 对象，用于提供 API 的一些基本信息。
ApiInfo 配置内容

  • title：API 文档的标题，在文档页面上显示。

  • description：API 文档的描述，提供有关 API 的更多信息。

  • version：API 的版本号，可以帮助区分不同版本的 API。

运行项目

访问http://localhost:8080/doc.html   (端口可以调整)

进行接口测试

当前

进入调试页面

测试通过

雨落白笙
关注
  • 18
    点赞
  • 踩
  • 27
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
appapidemo:springboot集合mybatis使用swagger2搭建api后台
05-10
此项目为图书管理系统后台，使采用的是springboot+mybatis等技术实现数据持久化以及api服务调用， 前台使用vue.js,vue-resource,vue-router,iView2.0UI框架,vue-quill-editor等技术实现前台页面，前台地址是: 由于...
cds:springboot、mybatis、swagger 干净的项目架构
05-14
光盘springboot，mybatis，swagger干净的项目架构sql脚本设置名称utf8mb4; SET FOREIGN_KEY_CHECKS = 0; -TEST_USER的表结构如果存在TEST_USER ，则删除表； CREATE TABLE TEST_USER （ id int（11）NOT NULL AUTO_...
SpringBoot+Mybatis项目框架搭建源码
03-05
在本项目中，我们主要探讨如何使用SpringBoot与Mybatis技术构建一个微服务框架。SpringBoot以其便捷的初始化和配置方式，大大简化了Java应用的开发流程，而Mybatis作为轻量级持久层框架，提供了灵活的SQL操作，使得...
spring-boot-mybatis-demo:springboot集成mybatis,swagger
05-10
本篇文章将详细介绍如何在 Spring Boot 项目中整合 MyBatis，并通过 Swagger 实现 API 的文档化管理。 首先，我们需要在项目中引入 Spring Boot 和 MyBatis 的依赖。在 `pom.xml` 文件中，添加如下依赖： ```xml ...
spring-boot-seed:SpringBoot骨架项目，集成SpringBoot、Mybatis、Druid、Mapper、PageHelper、Redis、Shiro、Swagger2、Log4j2等技术
05-10
spring-boot-seed项目介绍SpringBoot的种子框架项目，个人学习使用，集成一些常用的框架功能，方便快速开发。软件架构spring-boot-seed ├── src/main/java/com.dazzlzy | ├── common -- 通用代码包 | | ├─...
分享一个基于Spring Boot的在线智慧考公学习管理系统（源码、调试、LW、开题、PPT）
最新发布
m0_72599287的博客
08-04 446
随着公务员考试竞争的日益激烈，传统的备考模式已经难以满足考生多样化、个性化的学习需求。考生需要更加灵活、系统化的备考方式，而教育技术的迅速发展为这一需求提供了新的解决方案。基于SpringBoot的在线智慧考公系统，结合Vue、MySQL和Echarts等先进技术，旨在构建一个集学习资源、考试测评和数据分析于一体的智慧平台。通过系统，管理员可以高效管理用户、教师、岗位类型和学习资源，确保平台内容的准确性和丰富性；考生可以通过注册和登录访问个性化的学习资源、进行模拟测试，并查看详细的成绩分析，提升备考效率；教
Spring Boot 整合 Dubbo3 + Nacos 2.4.0
小天一直在路上
08-01 437
Nacos 作为 Dubbo 生态系统中重要的注册中心实现，本文将会介绍如何进行 Dubbo 对接 Nacos 注册中心的工作。
Java中spring boot validation 自定义注解使用
c8899y的博客
08-04 496
Constraint(validatedBy = {IsSystemYesNoVaildation.class})//绑定 在这里会报错 你需要去实现。String message() default "数据字典：【系统是否】-参数不合法";ConstraintValidator {//实现。@Target({ElementType.FIELD})//需要写注解的三三个要素。//入参 类型。//把video传进来 自定义注解就写好了。
分享一个基于人脸识别的小区物业管理系统Spring Boot（源码、调试、LW、开题、PPT）
m0_72599287的博客
08-04 441
随着城市化进程的加快，小区物业管理面临着日益复杂的管理需求和安全隐患。传统的物业管理模式往往依赖人工操作，效率低下且容易出错，无法满足居民对安全和便捷服务的期望。人脸识别技术的迅速发展为物业管理提供了新的解决方案，能够实现快速、准确的出入管理，提高小区的安全性。结合现代化的信息管理系统，物业管理者可以更高效地处理用户的需求，包括房屋信息管理、维修申请和费用管理等，从而提升服务质量。基于Spring Boot、Vue和MySQL技术开发的基于人脸识别的小区物业管理系统，旨在整合各项管理功能，构建一个智能化、数
Spring Boot 3 + MinIO集群 + Nginx 负载均衡 实现图片（头像）的上传 + 更新替换 + 下载 简单案例
liber.info
08-04 743
通过docker-compose实现了MinIO集群和Nginx的负载均衡，通过Spring Boot 整合MinIo实现图片的上传和下载。
Spring Boot常用注解
东皋长歌的专栏
08-03 922
Component注解是一个通用的注解，可以用来标注任何Spring管理的bean，像@Service，@Controller，@Repository都是@Component注解的别名。用途：@Data是一个复合注解，集成了@Getter，@Setter，@ToString，@EqualsAndHashCode，@RequiredArgsConstuctor等注解。用途：用于标识控制层组件，是@Component注解的别称，用于标识Spring MVC控制器，处理Web请求并返回视图。
Spring Boot(八十四)：集成Thumbnailator来生成缩略图
u013938578的博客
08-04 338
Thumbnailator是一个用于Java的缩略图生成库。通过Thumbnailator提供的流畅接口(fluent interface)的方式可以完成复杂的缩略图处理任务，无需访问Image I/O API并通过Graphics2D对象手动操作BufferedImages。
基于Spring boot + Vue的校园论坛
NPCS_JQ的博客
08-04 164
以脚手架项目为基础完成的1.主页：echarts展示的图表2.系统管理：用户管理，角色管理，字典管理，菜单管理，日志管理3.文件管理：生成文件4.文章管理：集合富文本写文章5.公告管理：公告的管理6.轮播图管理：前台首页的轮播图7.论坛管理8.禁言管理9.评论管理10.失物管理11.闲置管理。
JSONP跨域
zhuge_long的专栏
07-31 496
json存在的意义：不同类型的语言，都能识别jsonJSONP(JSON with Padding)是JSON的一种“使用模式”，可用于解决主流浏览器的跨域数据访问的问题。由于同源策略，一般来说位于server1.的网页无法与不是 server1.example.com的服务器沟通，而HTML的浏览器A从服务器B获取的静态资源，包括Html、Css、Js，然后在Js中通过Ajax访问C服务器的静态资源或请求。即：浏览器A从B服务器拿的资源，资源中想访问服务器C的资源。
前后端demo-WarehouseManagement
qq_53325717的博客
08-01 462
demo
后端跨域配置（用于支持前端地址与后端地址不同）
qq_41709084的博客
08-01 242
Override。
快手商业化 Java后端 二面｜面试官很nice
程序员世杰
07-31 421
面试官很nice，在答不上来的时候会引导我去思考，并在我回答正确的时候给与充分的肯定
Servlet(2)
xjdkxnhcoskxbco的博客
08-04 345
这个注解可以用来修饰一个Servlet类，可以简化配置，替代Web.xml中 的servlet配置。
举例详细学习和分析后端业务逻辑代码开发思路（二）
weixin_73889628的博客
07-31 437
今天继续来一个简单清晰的业务逻辑开发！加油加油
springboot 项目搭建 mybatis swagger nacos
05-27
好的，下面是详细步骤： 1. 创建一个新的 Spring Boot 项目。 2. 在 `pom.xml` 文件中添加对 MyBatis、Swagger 和 Nacos 的依赖： ```xml <!-- MyBatis --> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.2.0</version> </dependency> <!-- Swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <!-- Nacos --> <dependency> <groupId>com.alibaba.nacos</groupId> <artifactId>nacos-client</artifactId> <version>1.4.0</version> </dependency> ``` 3. 配置 MyBatis 和数据源，在 `application.properties` 文件中添加以下配置： ```properties # MyBatis mybatis.mapper-locations=classpath*:mapper/*.xml # 数据源 spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC spring.datasource.username=root spring.datasource.password=123456 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver ``` 4. 配置 Swagger，创建一个 `SwaggerConfig` 类： ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Swagger API") .description("Swagger API 文档") .version("1.0.0") .build(); } } ``` 5. 配置 Nacos，创建一个 `NacosConfig` 类： ```java @Configuration public class NacosConfig { @Value("${spring.cloud.nacos.discovery.server-addr}") private String serverAddr; @Value("${spring.application.name}") private String appName; @Bean public void init() { Properties properties = new Properties(); properties.put("serverAddr", serverAddr); NacosConfigService configService = NacosFactory.createConfigService(properties); try { String content = configService.getConfig(appName, "DEFAULT_GROUP", 5000); // 解析配置内容 } catch (NacosException e) { e.printStackTrace(); } } } ``` 注意，上面的代码中使用了 `@Value` 注解，需要在 `application.properties` 文件中添加以下配置： ```properties # Nacos spring.cloud.nacos.discovery.server-addr=localhost:8848 spring.cloud.nacos.discovery.namespace= spring.cloud.nacos.config.namespace= spring.cloud.nacos.config.group=DEFAULT_GROUP spring.cloud.nacos.config.file-extension=properties ``` 至此，你已经成功搭建了一个 Spring Boot 项目，并且集成了 MyBatis、Swagger 和 Nacos。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值