第二章：给项目配置数据源，redis，security,swagger等工具jar

旧城等待， 2023-02-13 14:35 63阅读 0赞

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.2.6.RELEASE</version>
          <relativePath/>
       </parent>
       <groupId>com.hzw.code</groupId>
       <artifactId>fast</artifactId>
       <version>0.0.1-SNAPSHOT</version>
       <name>fast</name>
       <description>Demo project for Spring Boot</description>
    
       <properties>
          <java.version>1.8</java.version>
       </properties>
    
       <dependencies>
          <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter</artifactId>
          </dependency>
          <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
          </dependency>
          <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-actuator</artifactId>
          </dependency>
          
          <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-security</artifactId>
          </dependency>
          <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>
          </dependency>
          
          <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-data-redis</artifactId>
          </dependency>
          <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>
             <version>3.9</version>
          </dependency>
          
          <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>
          
          <dependency>
             <groupId>com.github.xiaoymin</groupId>
             <artifactId>swagger-bootstrap-ui</artifactId>
             <version>1.9.4</version>
          </dependency>
          <dependency>
             <groupId>mysql</groupId>
             <artifactId>mysql-connector-java</artifactId>
          </dependency>
          
          <dependency>
             <groupId>com.alibaba</groupId>
             <artifactId>druid-spring-boot-starter</artifactId>
             <version>1.1.18</version>
          </dependency>
          
          <dependency>
             <groupId>com.baomidou</groupId>
             <artifactId>mybatis-plus-boot-starter</artifactId>
             <version>3.2.0</version>
          </dependency>
          
          <dependency>
             <groupId>com.github.pagehelper</groupId>
             <artifactId>pagehelper-spring-boot-starter</artifactId>
             <version>1.2.12</version>
          </dependency>
          
          <dependency>
             <groupId>com.alibaba</groupId>
             <artifactId>fastjson</artifactId>
             <version>1.2.58</version>
          </dependency>
          
          <dependency>
             <groupId>com.github.ulisesbocchio</groupId>
             <artifactId>jasypt-spring-boot-starter</artifactId>
             <version>2.1.1</version>
          </dependency>
          
          <dependency>
             <groupId>org.modelmapper</groupId>
             <artifactId>modelmapper</artifactId>
             <version>2.3.6</version>
          </dependency>
          <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
             <exclusions>
                <exclusion>
                   <groupId>org.junit.vintage</groupId>
                   <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
             </exclusions>
          </dependency>
       </dependencies>
    
       <build>
          <plugins>
             <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
             </plugin>
          </plugins>
       </build>
    
    </project>

上面就是我们要用到的一些jar包了，其实当中有很多jar是我们用不到的，可以使用exclusion标签来对不需要的jar进行剔除。

application.yml

spring:
      application:
        name: fast
        version: 1.0.0
      profiles:
        # 配置激活
        active: local
    # 日志
    logging:
      file:
        name: logs/fast.log

application-local.yml

server:
      port: 8080
      servlet:
        context-path: /
    spring:
      application:
        name: fast
      # druid数据库连接池配置
      datasource:
        name: test
        url: 'jdbc:mysql://127.0.0.1:3306/fast?useUnicode=true&characterEncoding=utf8&useSSL=false&useAffectedRows=true&serverTimezone=GMT%2B8&allowMultiQueries=true'
        username: root
        password: hzwykx1999
        type: com.alibaba.druid.pool.DruidDataSource
        driver-class-name: com.mysql.cj.jdbc.Driver
        druid:
          # 最大连接数
          maxActive: 30
          # 初始化连接数
          initialSize: 5
          # 最小连接数
          minIdle: 1
          # 配置获取连接等待超时的时间
          maxWait: 60000
          # 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒
          timeBetweenEvictionRunsMillis: 60000
          # 配置一个连接在池中最小生存的时间，单位是毫秒
          minEvictableIdleTimeMillis: 300000
          validationQuery: select 'x'
          testWhileIdle: true
          testOnBorrow: false
          testOnReturn: false
          # 打开PSCache，并且指定每个连接上PSCache的大小
          poolPreparedStatements: true
          maxOpenPreparedStatements: 20
          # 配置监控统计拦截的filters，去掉后监控界面sql无法统计，'wall'用于防火墙
          filters: stat,wall,slf4j
          # 通过connectProperties属性来打开mergeSql功能；慢SQL记录
          connectionProperties: druid.stat.mergeSql\=true;druid.stat.slowSqlMillis\=5000
      #redis 配置
      redis:
        database: 2
        host: 127.0.0.1
        port: 6379
        password:
        jedis:
          pool:
            max-active: 8 # 连接词最大链接数
            max-wait: -1 # 连接池最大阻塞等待时间（负数代表没有限制）
            max-idle: 8 # 连接池最大空闲连接数
            min-idle: 0 # 连接池最小空闲连接数
        timeout: 10000 # 链接超时时间 （ms）,连接时间小会导致连接超时
    # 系统配置
    app:
      # swagger配置
      swagger:
        # 是否启用swagger，正式环境关闭
        enabled: true
        # 设置tokenkey，无则不设置
        tokenKey: fast-token
        # 扫描包位置，不配置则默认为com
        basePackage: 'com.hzw.code.fast'
        # swagger相关配置
        title: '快速开发平台API文档'
        description: '快速开发平台API文档'
        termsOfServiceUrl: 'https://gitee.com/gzsjd/fast'
        authorName: '胡汉三'
        authorUrl: 'https://blog.csdn.net/hzw2312'
        authorEmail: 'hzw2312@sina.com'
        version: '1.0.0'

创建一个测试Controller

/**
     * 测试控制器
     */
    @RestController
    @RequestMapping("test")
    public class TestController {
    
        @GetMapping("/{test}")
        public Object test(@PathVariable String test){
            return test + " 你好！";
        }
    }

swagger的配置SwaggerProperty

import lombok.Data;
    import org.apache.commons.lang3.StringUtils;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    /**
     * swagger参数
     */
    @Component
    @ConfigurationProperties(prefix = "app.swagger")
    @Data
    public class SwaggerProperty {
    
       /**
        * 是否启用swagger，正式环境关闭
        */
       private Boolean enabled;
    
       /**
        * 设置tokenkey，无则不设置（为后面做无状态访问作准备）
        */
       private String tokenKey;
    
       private String baseUrl;
    
       private String title;
    
       private String description;
    
       private String termsOfServiceUrl;
    
       private String authorName;
    
       private String authorUrl;
    
       private String authorEmail;
    
       private String version;
    
       /**
        * 扫描包位置，不配置则默认为com
        */
       private String basePackage;
    
       public String getBasePackage() {
          return StringUtils.isNoneBlank(basePackage) ? basePackage : "com";
       }
    }

swagger的配置SwaggerConfig

import com.hzw.code.fast.config.property.SwaggerProperty;
    import org.apache.commons.lang3.StringUtils;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import springfox.documentation.builders.ApiInfoBuilder;
    import springfox.documentation.builders.ParameterBuilder;
    import springfox.documentation.builders.PathSelectors;
    import springfox.documentation.builders.RequestHandlerSelectors;
    import springfox.documentation.schema.ModelRef;
    import springfox.documentation.service.ApiInfo;
    import springfox.documentation.service.Contact;
    import springfox.documentation.service.Parameter;
    import springfox.documentation.spi.DocumentationType;
    import springfox.documentation.spring.web.plugins.Docket;
    import springfox.documentation.swagger2.annotations.EnableSwagger2;
    
    import java.util.ArrayList;
    import java.util.List;
    
    /**
     * swagger配置类
     */
    @Configuration
    @EnableSwagger2
    public class SwaggerConfig {
    
       @Autowired
       SwaggerProperty swaggerProperty;
    
       @Bean
       public Docket api() throws Exception{
          //添加head参数start
          ParameterBuilder tokenPar = new ParameterBuilder();
          List<Parameter> pars = new ArrayList<Parameter>();
          String tokenKey = swaggerProperty.getTokenKey();
    
          if(StringUtils.isNotBlank(tokenKey)){
             tokenPar.name(tokenKey).description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
          }
    
          pars.add(tokenPar.build());
          //添加head参数end
          return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage(swaggerProperty.getBasePackage()))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars)
                .enable(swaggerProperty.getEnabled())
                 // .host("")
                .apiInfo(apiInfo());
       }
    
       public ApiInfo apiInfo() throws Exception {
          return new ApiInfoBuilder().title(swaggerProperty.getTitle()).description(swaggerProperty.getDescription())
                .termsOfServiceUrl(swaggerProperty.getTermsOfServiceUrl())
                .contact(new Contact(swaggerProperty.getAuthorName(), swaggerProperty.getAuthorUrl(), swaggerProperty.getAuthorEmail())).version(swaggerProperty.getVersion())
                .build();
       }
    }

这里需要在idea安装一下插件，Lombok还有mybatis的

![format_png][]

开始测试，由于使用的security我们需要注意启动的时候控制打印的密码。

![format_png 1][]

在浏览器访问时，提示需要登录，就使用上面的密码

Using generated security password: 02bce6d8-8c89-4e15-86c3-587b5ba1cca3

![format_png 2][]

进入我们的测试页面[http://localhost:8080/test/fast][http_localhost_8080_test_fast]

![format_png 3][]

要注意，由于我们配置了security，进入test跟swagger页面都是因为登录成功了才能访问的，不然只能访问到登录页面。下一章我们开始进行security的学习跟配置

\----------------------------------------------------------

项目的源码地址：[https://gitee.com/gzsjd/fast][https_gitee.com_gzsjd_fast]

\----------------------------------------------------------

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9ub3RlLnlvdWRhby5jb20veXdzL3B1YmxpYy9yZXNvdXJjZS81YjMyMmE0Mjk2NTRkOWNjNDVjZWYxZDgzMGVhNTZkZS94bWxub3RlLzg2Mjk2QkNCNzkxQjQzNjc5ODRBNDk4MUM0NEY0RUM4LzU1Ng?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9ub3RlLnlvdWRhby5jb20veXdzL3B1YmxpYy9yZXNvdXJjZS81YjMyMmE0Mjk2NTRkOWNjNDVjZWYxZDgzMGVhNTZkZS94bWxub3RlL0REODhGQUM5QTJDOTQyMTE4Qjc0NUE5OEZFNURBRjU1LzUzNQ?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9ub3RlLnlvdWRhby5jb20veXdzL3B1YmxpYy9yZXNvdXJjZS81YjMyMmE0Mjk2NTRkOWNjNDVjZWYxZDgzMGVhNTZkZS94bWxub3RlLzY0RUZBNkFCOTAyQTRDMzVBNUIyN0Y3RDU4ODIyQjAzLzUzOA?x-oss-process=image/format,png
[http_localhost_8080_test_fast]: http://localhost:8080/test/fast
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9ub3RlLnlvdWRhby5jb20veXdzL3B1YmxpYy9yZXNvdXJjZS81YjMyMmE0Mjk2NTRkOWNjNDVjZWYxZDgzMGVhNTZkZS94bWxub3RlLzkyOUZEQ0EzQzUwMjQ3RkU5Qjc2MTY1RDA5NkFGQkZGLzU0NA?x-oss-process=image/format,png
[https_gitee.com_gzsjd_fast]: https://gitee.com/gzsjd/fast