springboot整合第三方框架

一、 springboot整合mybatis

项目结构

引入依赖

 <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--mysql的驱动依赖 3.-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--mybatis和springboot整合的jar.-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </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>
    </dependencies>

配置文件

spring.application.name=springboot-mybatis

#数据源的信息
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/springboot?serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root


#配置mybatis映射文件的路径
mybatis.mapper-locations=classpath:mapper/*.xml

实体类

@Data
public class User {
    private Integer userid;
    private String username;
    private String sex;
    private Integer age;
}

dao 

public interface UserDao {
    int insert(User user);
    int delete(Integer id);
    int update(User user);
    User select(Integer id);
    List<User> selectAll();
}

映射文件

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.zql.dao.UserDao">

    <insert id="insert">
        insert into user(username,age,sex) values(#{username},#{age},#{sex})
    </insert>
    <update id="update">
        update user set username=#{username},age=#{age},sex=#{sex} where userid=#{userid}
    </update>
    <delete id="delete">
        delete from user where userid=#{id}
    </delete>
    <select id="selectById" resultType="com.zql.entity.User">
        select * from user where userid=#{id}
    </select>
    <select id="selectAll" resultType="com.zql.entity.User">
        select * from user
    </select>

</mapper>

service

package com.zql.service.impl;

import com.zql.dao.UserDao;
import com.zql.entity.User;
import com.zql.service.UserService;
import com.zql.vo.R;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserDao userDao;
    @Override
    public R selectAll() {
        List<User> users = userDao.selectAll();
        return new R(200,"查询成功",users);
    }

    @Override
    public R selectById(Integer id) {
        User user = userDao.selectById(id);
        if(user==null){
            return new R(500,"查询失败",null);
        }else{
            return new R(200,"查询成功",user);
        }
    }

    @Override
    public R insert(User user) {
        int i = userDao.insert(user);
        if(i>0){
            return new R(200,"添加成功",null);
        }
        return new R(500,"添加失败",null);
    }

    @Override
    public R update(User user) {
        int update = userDao.update(user);
        if (update>0){
            return new R(200,"修改成功",null);
        }
        return new R(500,"修改失败",null);
    }

    @Override
    public R delete(Integer id) {
        int i = userDao.delete(id);
        if (i>0){
            return new R(200,"删除成功",null);
        }
        return new R(500,"删除失败",null);
    }
}

package com.zql.service;

import com.zql.entity.User;
import com.zql.vo.R;


public interface UserService {
     R insert(User user);
     R delete(Integer id);
     R update(User user);
     R selectById(Integer id);
     R selectAll();
}

controller代码

package com.zql.controller;

import com.zql.entity.User;
import com.zql.service.UserService;
import com.zql.vo.R;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;


@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;
    @GetMapping("/list")
    public R list() {
        return userService.selectAll();
    }

    //getById/1
    @GetMapping("/getById")
    public R getById(Integer id) {
        return userService.selectById(id);
    }

    @DeleteMapping("/deleteById")
    public R deleteById(Integer id) {
        return userService.delete(id);
    }

    @PostMapping("/insert")
    public R insert(@RequestBody User user) {
        return userService.insert(user);
    }

    @PutMapping("/update")
    public R update(@RequestBody User user) {
        return userService.update(user);
    }


}

R

package com.zql.vo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;


@Data
@AllArgsConstructor
@NoArgsConstructor
public class R {
    private Integer code;
    private String msg;
    private Object data;
}

启动类

在里面加给注解为@MapperScan("com.zql.dao")

package com.zql;

import org.apache.ibatis.annotations.Mapper;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.zql.dao")
public class SpringBoot02MybatisApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBoot02MybatisApplication.class, args);
    }

}

二、springboot整合swagger2

什么是swagger2

Swagger2 是一个规范和完整的框架，用于生成、描述、调用和可视化Restful风格的web服务，现在我们使用spring boot 整合它。作用：
接口的文档在线自动生成；
功能测试；

为什么需要使用swagger2

1. API文档自动生成: Swagger2能够根据代码中的注解自动生成API文档，包括接口的详细描述、请求和响应的数据格式、参数说明等。这样做可以节省大量手动编写和维护API文档的时间，同时保持文档与实际代码的一致性。

2. 可视化API测试: Swagger2生成的API文档提供了一个交互式的API测试界面（Swagger UI），开发人员可以直接在浏览器中进行API的调试和测试，无需额外安装其他工具或使用curl等命令行工具。

3. 接口定义的标准化: 使用Swagger2可以规范接口的定义和描述，包括路径、参数、响应等，使得整个团队在接口开发和使用过程中更加统一和规范化。

4. 便于前后端协作: 前端开发人员可以根据Swagger2生成的API文档快速理解和调用后端提供的接口，避免因为接口定义不清晰或者不一致而导致的沟通问题和开发延误。

5. 实时更新文档: Swagger2集成到项目中后，只需简单的配置和注解即可自动更新API文档，对于频繁变动的API接口特别有用，保持文档的及时性和准确性。

6. 提升团队的技术形象: 提供规范和易用的API文档展示，可以提升团队的专业形象，对于外部合作伙伴和客户展示API时尤为重要。

如何使用swagger2

<!--引入swagger2依赖-->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.9.1.RELEASE</version>
        </dependency>
        <!--图形化依赖-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

创建swagger2配置类

package com.zql.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)
                // 通过调用自定义方法apiInfo，获得文档的主要信息
                .apiInfo(apiInfo())
                // 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
                .select()
                // 扫描指定包
                .apis(RequestHandlerSelectors.basePackage("com.zql.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/doc.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 接口文档标题
                .title("接口文档")
                // 对于接口文档的相关描述
                .description("接口文档")
                // 接口文档内容的一下补充
                .contact(new Contact("用户名", "http://localhost:8888/doc.html", "邮箱"))
                // 版本
                .version("1.0")
                .build();
    }
}

开启swagger的注解驱动

swagger2常用注解

1. @Api(tags=“”)： 使用在接口类上，对接口类的说明
2. @ApiOperation(value=""):接口方法上，对接口方法的说明
3. @ApiImplicitParams(
           @ApiImplicitParam(name=“参数名”,value="参数说明",require="是否必写",dataType="数据类型") 
    ) : 接口方法所有参数的概述
    
4. @ApiModel(value=""): 使用在实体类上，对实体类的说明
5. @ApiModelProperty(value=""):使用在实体类属性上，对属性的说明

三、springboot整合定时器

1 什么定时器

在指定的任务里，完成相应的任务

2 为什么使用定时器

在一些支付订单时在30分钟之后订单要取消可以使用定时器来完成

3 怎么使用定时器

引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

创建一个定时业务类

package com.zql.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.Scheduled;


@Configuration
public class MyQuartzConfig {

    //定时业务代码
    //定义定时规则
    /**
     * 定时任务，每隔5分钟执行一次。
     * 通过@Scheduled注解指明该方法为定时任务，cron表达式"0/5 * * * * ?"表示每5分钟执行一次。
     * 该方法主要用于执行一些定期的业务操作，例如发送短信、清理OSS冗余文件、取消过期订单等。
     * 由于具体业务操作未在代码中展示，因此这里仅提供了一个示例性的注释说明。
     */
    @Scheduled(cron = "0/5 * * * * ?")
    public void show(){
        System.out.println("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
        // 发生短信 或者删除oss冗余文件 或者取消订单
    }

}

开启定时器注解驱动

四、springboot整合mybatis-plus

概述

MyBatis-Plus 是一个 MyBatis 的增强工具，在 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

准备条件

 建立个user表

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user`  (
  `uid` int NOT NULL AUTO_INCREMENT,
  `uname` varchar(255) CHARACTER SET utf8 COLLATE utf8_bin NULL DEFAULT NULL,
  `password` varchar(255) CHARACTER SET utf8 COLLATE utf8_bin NULL DEFAULT NULL,
  PRIMARY KEY (`uid`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 1007 CHARACTER SET = utf8 COLLATE = utf8_bin ROW_FORMAT = Dynamic;

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES (1001, '123456', 'aaa123');
INSERT INTO `user` VALUES (1002, '12345678', 'zzz123');
INSERT INTO `user` VALUES (1003, 'abc123', 'aaa123456');
INSERT INTO `user` VALUES (1004, '1234', '123456');
INSERT INTO `user` VALUES (1005, 'admin', '123456');

引入依赖

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

实体类

package com.zql.entity;

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@Data
@TableName("user") // 对应数据库中的表名
public class User {
    @TableId // 标识主键
    private Integer uid;

    private String uname;

    private String password;
}

mapper

package com.zql.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.zql.entity.User;


public interface UserMapper extends BaseMapper<User> {
}

为mapper生成代理实现类

测试

根据id查询

 

package com.zql;

import com.zql.entity.User;
import com.zql.mapper.UserMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class SpringBoot04MpApplicationTests {

    @Autowired
    private UserMapper userMapper;
    @Test
    void testSelectById() {
        User user = userMapper.selectById(1005);
        System.out.println(user);
    }

}