栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Swagger配置MybatisPlus配置

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Swagger配置MybatisPlus配置

项目启动访问本地地址
没有配置Swagger UI地址http://127.0.0.1:8080/swagger-ui.html

配置了swagger UI的地址http://localhost:8080/doc.html
项目结构

引入Swagger的pom文件

        
            io.springfox
            springfox-swagger2
            2.9.2
        
        
            io.springfox
            springfox-swagger-ui
            2.9.2
        
        
            io.springfox
            springfox-spi
            2.9.2
        

美化swagger UI导入,在pom文件中添加该依赖访问doc.html即可,原来的swagger依赖不删除(注意!在做了拦截的地方需要放行该地址)

        
            com.github.xiaoymin
            swagger-bootstrap-ui
            1.9.3
        

在config包中加入配置

package com.example.demo.config;

import io.swagger.annotations.Api;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class Swagger2Config {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
//                .enable(swaggerEnable)
                .apiInfo(apiInfo())
                .select()
//                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) //指定扫描包
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                //只显示api路径下的页面
                //.paths(Predicates.and(PathSelectors.regex("/api/.*")))
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("客户记录API文档")
                .description("客户记录API文档")
                .version("1.0.0")
                .build();
    }
}

pom

        
            org.springframework.boot
            spring-boot-starter-web
        

启动类上面加入@EnableSwagger2注解,扫描包@MapperScan(“com.example.demo.mapper”)


引入mybatis-plus

        
            com.baomidou
            mybatis-plus-boot-starter
            3.4.0
        

application.yml中连接数据库注意password密码有特殊符号需要加入’‘,例如’%Im9n9b&f’
mybatis-plus这作用是在控制台打印出执行的sql语句

# DataSource Config
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:8080/test?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: root
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

com.mysql.cj.jdbc.Driver报错,pom加入

        
            mysql
            mysql-connector-java
            8.0.22
        

数据库user.sql

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `name` varchar(30) DEFAULT NULL COMMENT '姓名',
  `age` int(11) DEFAULT NULL COMMENT '年龄',
  `email` varchar(50) DEFAULT NULL COMMENT '邮箱',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=13 DEFAULT CHARSET=utf8mb4;

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES ('1', 'Jone', '18', 'test1@baomidou.com');
INSERT INTO `user` VALUES ('2', 'Jack', '20', 'test2@baomidou.com');
INSERT INTO `user` VALUES ('3', 'Tom', '28', 'test3@baomidou.com');
INSERT INTO `user` VALUES ('4', 'Sandy', '21', 'test4@baomidou.com');
INSERT INTO `user` VALUES ('5', 'Billie', '24', 'test5@baomidou.com');
INSERT INTO `user` VALUES ('6', 'Billie111', null, null);
INSERT INTO `user` VALUES ('7', 'Billi2222', null, null);
INSERT INTO `user` VALUES ('9', '456456', null, null);
INSERT INTO `user` VALUES ('10', 'Billi2222', null, null);
INSERT INTO `user` VALUES ('11', 'Billi2222', null, null);
INSERT INTO `user` VALUES ('12', '', '0', '');

entity

package com.example.demo.entity;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

@Data
@ApiModel(value = "用户信息实体类")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    @ApiModelProperty(value = "名称")
    private String name;
    @ApiModelProperty(value = "年龄")
    private Integer age;
    @ApiModelProperty(value = "邮箱")
    private String email;
}


    4.0.0
    
        org.springframework.boot
        spring-boot-starter-parent
        2.5.6
         
    
    com.example
    demo4
    0.0.1-SNAPSHOT
    demo4
    demo4
    
        1.8
    
    
        
            org.springframework.boot
            spring-boot-starter
        

        
            org.springframework.boot
            spring-boot-starter-test
            test
        

        
            org.projectlombok
            lombok
            1.18.24
        
        
            io.springfox
            springfox-swagger2
            2.9.2
        
        
            io.springfox
            springfox-swagger-ui
            2.9.2
        
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            com.baomidou
            mybatis-plus-boot-starter
            3.4.0
        
        
            mysql
            mysql-connector-java
            8.0.22
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    



Mapper

package com.example.demo.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.demo.entity.User;

public interface UserMapper extends BaseMapper {
}

Service

package com.example.demo.service;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
import com.example.demo.entity.User;

public interface UserService extends IService {
    IPage pageInfo(IPage page, String name);
}

ServiceImpl

package com.example.demo.service.impl;

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.example.demo.entity.User;
import com.example.demo.mapper.UserMapper;
import com.example.demo.service.UserService;
import org.springframework.stereotype.Service;
import org.springframework.util.StringUtils;

import javax.annotation.Resource;

@Service
public class UserServiceImpl extends ServiceImpl implements UserService {
    @Resource
    private UserMapper userMapper;

    @Override
    public IPage pageInfo(IPage page, String name) {
        LambdaQueryWrapper wrapper = new LambdaQueryWrapper<>();
        wrapper.eq(!StringUtils.isEmpty(name), User::getName, name);
        return userMapper.selectPage(page, wrapper);
    }
}

mypage

package com.example.demo.vo;

import lombok.Data;

import java.io.Serializable;

@Data
public class MyPage implements Serializable {

    private long total;

    private long size;

    private long current;

    private T data;

    public MyPage(long total, long size, long current, T data) {
        this.total = total;
        this.size = size;
        this.current = current;
        this.data = data;
    }
}

引入mybatisplus的分页插件MybatisPlusConfig

package com.example.demo.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.autoconfigure.ConfigurationCustomizer;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MybatisPlusConfig {

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor();
        paginationInnerInterceptor.setDbType(DbType.MYSQL);
        paginationInnerInterceptor.setOverflow(true);
        interceptor.addInnerInterceptor(paginationInnerInterceptor);
        return interceptor;
    }

    @Bean
    public ConfigurationCustomizer configurationCustomizer() {
        return configuration -> configuration.setUseDeprecatedExecutor(false);
    }
}

Result

package com.example.demo.result;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.io.Serializable;

@Data
@ApiModel
public class Result implements Serializable {

    @ApiModelProperty(value = "请求状态码")
    private int code;

    private String msg;
    @ApiModelProperty(value = "data")
    private T data;

    private String result;

    public Result(int code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    public Result() {
    }

    public static  Result ok(){
        return new Result<>(200,"操作成功!",null);
    }


    public static  Result ok(T data){
        return new Result<>(200,"操作成功!",data);
    }

    public static  Result error(String error) {
        return new Result<>(500, error, null);
    }
}

UserController 这是根据名字分页查询

package com.example.demo.controller;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.example.demo.entity.User;
import com.example.demo.result.Result;
import com.example.demo.service.UserService;
import com.example.demo.vo.MyPage;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import java.util.List;

@Api(tags = "用户信息")
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @ApiOperation(value = "用户列表分页查询", notes = "用户列表分页查询")
    @GetMapping("/pageInfo")
    @ApiImplicitParams(
            {
                    @ApiImplicitParam(name = "pageNo", value = "当前页", dataType = "int", paramType = "query", example = "1", required = true),
                    @ApiImplicitParam(name = "pageSize", value = "每页显示数量", dataType = "int", paramType = "query", example = "1", required = true),
                    @ApiImplicitParam(name = "name", value = "名称", dataType = "String", paramType = "query", example = "1", required = false)
            }
    )
    public Result>> pageInfo(@RequestParam(value = "pageNo", defaultValue = "1") Integer pageNo,
                                               @RequestParam(value = "pageSize", required = true, defaultValue = "10") Integer pageSize,
                                               @RequestParam(value = "name", required = false) String name, HttpServletRequest request
    ) {
        IPage page = new Page<>(pageNo, pageSize);
        IPage userIPage = userService.pageInfo(page, name);
        return Result.ok(new MyPage<>(userIPage.getTotal(), userIPage.getSize(), userIPage.getCurrent(), userIPage.getRecords()));
    }
}

运行项目http://localhost:8080/user/pageInfo?pageNo=1&pageSize=3&name=Jone

{"code":200,"msg":"操作成功!","data":{"total":1,"size":3,"current":1,"data":[{"id":1,"name":"Jone","age":18,"email":"test1@baomidou.com"}]},"result":null}

运行Swagger
http://127.0.0.1:8080/swagger-ui.html
http://localhost:8080/doc.html

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/939147.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号