SpringBoot2——数据访问的集成 & 单元测试(JUnit5)

Posted AC_Jobim

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了SpringBoot2——数据访问的集成 & 单元测试(JUnit5)相关的知识,希望对你有一定的参考价值。

一、数据访问

1.1 数据库场景的自动配置(HikariDataSource)

  • SpringBoot 2.06 以后默认使用的是HikariDataSource数据源。
  • SpringBoot 默认配置了JdbcTemplate,JdbcTemplate是Spring框架自带的对JDBC操作的封装,配了数据源就可以直接使用它操作数据库即可

1、导入JDBC场景和数据库驱动

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

<!-- mysql驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
	<!--<version>5.1.49</version>-->
</dependency>

想要修改版本:
1、直接依赖引入具体版本(maven的就近依赖原则)
2、重新声明版本(maven的属性的就近优先原则)
<properties>
    <java.version>1.8</java.version>
    <mysql.version>5.1.49</mysql.version>
</properties>

2、修改配置项

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis_0325
    username: root
    password: root
    type: com.zaxxer.hikari.HikariDataSource # 系统默认的数据源
    driver-class-name: com.mysql.cj.jdbc.Driver # com.mysql.jdbc.Driver

3、测试能否连接上数据库

@SpringBootTest
class Boot05WebAdminApplicationTests {

    @Autowired
    JdbcTemplate jdbcTemplate;

    @Autowired
    DataSource dataSource;

    @Test
    void contextLoads() throws SQLException {

        System.out.println(dataSource.getClass());//class com.zaxxer.hikari.HikariDataSource
        System.out.println(dataSource.getConnection());//HikariProxyConnection@247309715 wrapping com.mysql.cj.jdbc.ConnectionImpl@5792c08c
        Long aLong = jdbcTemplate.queryForObject("select count(*) from t_student", Long.class);
        System.out.println(aLong);//3

    }
}

1.2 整合druid数据源

SprintBoot 默认使用的是 HikariDataSource数据源,这次整合一个第三方的数据源Druid ,它是阿里开发的一款开源的数据源,而且 Druid 能够提供强大的一整套监控和扩展功能。

druid官方github地址:https://github.com/alibaba/druid

1.2.1 自定义druid数据源

1、添加druid依赖

<!--druid数据源-->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.17</version>
</dependency>

2、在 application.yml(或aproperties)中添加相应的配置:

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis_0325
    username: root
    password: root
#    type: com.zaxxer.hikari.HikariDataSource # 系统默认的数据源
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.cj.jdbc.Driver # com.mysql.jdbc.Driver

3、在运行测试方法,查看数据源

@SpringBootTest
class Boot05WebAdminApplicationTests {

    @Autowired
    JdbcTemplate jdbcTemplate;
    @Autowired
    DataSource dataSource;

    @Test
    void contextLoads() throws SQLException {

        System.out.println(dataSource.getClass());
        System.out.println(dataSource.getConnection());
        Long aLong = jdbcTemplate.queryForObject("select count(*) from t_student", Long.class);
        System.out.println(aLong);//3
    }
}

4、配置Druid的监控

创建数据源配置类,进行配置

@Configuration
public class MyDataSourceConfig {

    //默认的自动配置是判断容器中没有才会配@ConditionalOnMissingBean(DataSource.class)
    //使用该方法可以去掉配置文件中的,type: com.alibaba.druid.pool.DruidDataSource
    @ConfigurationProperties("spring.datasource")
    @Bean
    public DataSource dataSource() throws SQLException {
        DruidDataSource druidDataSource = new DruidDataSource();
        //Druid内置提供一个StatFilter,用于统计监控信息,StatFilter的别名是stat
        //配置监控统计拦截的filters,去掉后监控界面sql无法统计,'wall'用于防火墙
        druidDataSource.setFilters("stat,wall");
        return druidDataSource;
    }

    /**
     * 配置 druid的监控页功能
     * @return
     */
    @Bean
    public ServletRegistrationBean statViewServlet() {

        //StatViewServlet的用途包括:
        //1.提供监控信息展示的html页面
        //2.提供监控信息的JSON API
        StatViewServlet statViewServlet = new StatViewServlet();

        ServletRegistrationBean<StatViewServlet> registrationBean = new ServletRegistrationBean<>(statViewServlet, "/druid/*");
        //配置监控页面访问密码
        registrationBean.addInitParameter("loginUsername","admin");
        registrationBean.addInitParameter("loginPassword","123456");

        return registrationBean;
    }

    /**
     * WebStatFilter 用于采集web-jdbc关联监控的数据。
     */
    @Bean
    public FilterRegistrationBean webStatFilter() {
        WebStatFilter webStatFilter = new WebStatFilter();
        FilterRegistrationBean<WebStatFilter> filterRegistrationBean = new FilterRegistrationBean<>(webStatFilter);
        filterRegistrationBean.setUrlPatterns(Arrays.asList("/*"));
        filterRegistrationBean.addInitParameter("exclusions","*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*");
        return filterRegistrationBean;
    }

}

访问http://localhost:8080/druid, 查看下监控

1.2.2 使用官方starter方式

1、在 Spring Boot 项目中加入druid-spring-boot-starter依赖

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.1.17</version>
</dependency>

2、分析自动配置(DruidDataSourceAutoConfigure )

@Configuration
@ConditionalOnClass({DruidDataSource.class})
@AutoConfigureBefore({DataSourceAutoConfiguration.class})
@EnableConfigurationProperties({DruidStatProperties.class, DataSourceProperties.class})
@Import({DruidSpringAopConfiguration.class, DruidStatViewServletConfiguration.class, DruidWebStatFilterConfiguration.class, DruidFilterConfiguration.class})
public class DruidDataSourceAutoConfigure {
  • @AutoConfigureBefore({DataSourceAutoConfiguration.class})表明在SpringBoot默认的配置源之前配置
  • DruidSpringAopConfiguration.class, 监控SpringBean的配置
  • DruidStatViewServletConfiguration.class, 监控页的配置
  • DruidWebStatFilterConfiguration.class, web监控配置
  • DruidFilterConfiguration.class 所有Druid自己filter的配置

3、配置文件编写

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis_0325
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver # com.mysql.jdbc.Driver

4、在运行测试方法,查看数据源

@SpringBootTest
class Boot05WebAdminApplicationTests {

    @Autowired
    JdbcTemplate jdbcTemplate;

    @Autowired
    DataSource dataSource;

    @Test
    void contextLoads() throws SQLException {

        System.out.println(dataSource.getClass());
        System.out.println(dataSource.getConnection());
        Long aLong = jdbcTemplate.queryForObject("select count(*) from t_student", Long.class);
        System.out.println(aLong);//3
    }
}

执行结果:

5、通过全局配置文件yml方式配置Druid的监控

SpringBoot配置示例:https://github.com/alibaba/druid/tree/master/druid-spring-boot-starter

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis_0325
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver # com.mysql.jdbc.Driver

    druid:
      aop-patterns: com.zb.admin.*  #监控SpringBean
      filters: stat,wall     # 底层开启功能,stat(sql监控),wall(防火墙)

      stat-view-servlet: # 配置监控页功能
        enabled: true
        login-username: admin
        login-password: 123456
        resetEnable: false # 不设置重置按钮

      web-stat-filter: # 监控web
        enabled: true
        urlPattern: /* #默认值
        exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*' # 注意使用单引号,不会转义,默认值


      filter:
        stat: # 对上面filters里面的stat的详细配置
          slow-sql-millis: 1000
          logSlowSql: true 
          enabled: true
        wall:
          enabled: true
          config:
            drop-table-allow: false # 配置不允许删除表

后台页面,访问http://localhost:8080/druid

这样就可以监控我们通过Druid连接池来进行的请求了。

1.3 整合MyBatis操作(重点)

mybatis的github链接https://github.com/mybatis
官网:https://mybatis.org/mybatis-3/zh/index.html

1.3.1 整合过程

  • 项目结构:

1、导入依赖

<!--数据库驱动-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<!--mybatis相关依赖-->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.0</version>
</dependency>
<!--druid相关依赖-->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.1.17</version>
</dependency>

mybatis-spring-boot-starter的依赖关系

2、创建实体类

@Data
public class City {
    private Long id;
    private String name;
    private String state;
    private String country;
}

3、编写配置文件

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis_0325
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver # com.mysql.jdbc.Driver

mybatis:
  mapper-locations: classpath:mybatis/mapper/*.xml # mapper文件所在文件夹
  configuration: # 指定mybatis全局配置文件中的相关配置项
    map-underscore-to-camel-case: true # 采用驼峰命名方式转换

4、创建mapper接口,并标记@Mapper注解

可以使用注解或者xml的方式实现,这里展示混合的方式实现

  1. 定义CityMapper接口文件

    @Mapper // 这里必须要添加这个Mapper注解; 也可以在主启动类上统一通过@MapperScan(value="con.zb.admin.mapper")来扫描
    public interface CityMapper {
    
        @Select("select * from city where id=#{id}")
        public City getById(Long id);
    
        //@Insert("insert into city(`name`,`state`,`country`) values(#{name},#{state},#{country})")
        //@Options(useGeneratedKeys = true,keyProperty = "id")
        public void insert(City city);
    
    }
    
  2. 创建CityMapper .xml映射文件

    <?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.zb.admin.mapper.CityMapper">
    
        <!--public void insert(City city);-->
        <insert id="insert" useGeneratedKeys="true" keyProperty="id">
            insert into city(`name`,`state`,`country`) values(#{name},#{state},#{country})
        </insert>
    
    </mapper>
    
  3. 配置文件(application.yaml)中指定映射文件的位置

    mybatis:
      mapper-locations: classpath:mybatis/mapper/*.xml # mapper文件所在文件夹
    

5、编写Controller层

@Controller
public class IndexController {
    @Autowired
    CityService cityService;

    @ResponseBody
    @GetMapping("/city")
    public City getCityById(Long id){
        return cityService.getById(id);
    }
}

测试结果:

1.3.2 修改Mybatis配置

以开启驼峰命名法为例

方法一:使用配置文件(application.yaml)的方式(推荐)

配置文件mybatis.configuration开头的,就是相当于改mybatis全局配置文件中的值

mybatis:
  mapper-locations: classpath:mybatis/mapper/*.xml # mapper文件所在文件夹
  configuration: # 指定mybatis全局配置文件中的相关配置项
    map-underscore-to-camel-case: true # 采用驼峰命名方式转换

方法二:使用mybatis全局配置文件(不推荐)

  1. 创建mybatis全局配置文件

    <?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE configuration
            PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
            "http://mybatis.org/dtd/mybatis-3-config.dtd">
    <configuration>
    
        <!-- 开启数据库中列名和pojp的驼峰命名映射 -->
        <settings>
            <setting name="mapUnderscoreToCamelCase" value="true"/>
        </settings>
    </configuration>
    
  2. 配置文件(application.yaml)中指定配置文件和映射文件的位置

    mybatis:
      config-location: classpath:mybatis/mybatis-config.xml # 配置文件所在位置
      mapper-locations: classpath:mybatis/mapper/*.xml # mapper文件所在文件夹
    

总结:

  1. 引入mybatis-starter
  2. 配置application.yaml中,指定mapper-location位置即可
  3. 编写Mapper接口并标注@Mapper注解
    • 简单方法直接注解方式
    • 复杂方法编写mapper.xml进行绑定映射

注意:如果不想使用@Mapper注解标注,可以使用@MapperScan("com.zb.admin.mapper")简化。

1.4 整合MyBatis-Plus完成CRUD(重点)

导入依赖:

<!--mybatis-plus的springboot支持-->
<dependency>
  <groupId>com.baomidou</groupId>
  <artifactId>mybatis-plus-boot-starter</artifactId>
  <version>3.4.3</version>
</dependency>
<!--mysql驱动-->
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.47</version>
</dependency>
<!--druid相关依赖-->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid-spring-boot-starter</artifactId>
    <version>1.1.17</version>
</dependency>

注意: Mybatis 及 Mybatis-Spring 依赖请勿加入项目配置,以免引起版本冲突!!!Mybatis-Plus 会自动帮你维护!

自动配置:

  • MybatisPlusAutoConfiguration 配置类,MybatisPlusProperties 配置项绑定。mybatis-plus:xxx 就是对mybatis-plus的定制

  • SqlSessionFactory 自动配置好。底层是容器中默认的数据源

  • mapperLocations 自动配置好的。有默认值。classpath*:/mapper/**/*.xml;任意包的类路径下的所有mapper文件夹下任意路径下的所有xml都是sql映射文件。 建议以后sql映射文件,放在 mapper下

  • 容器中也自动配置好了 SqlSessionTemplate

  • @Mapper标注的接口也会被自动扫描;建议直接 @MapperScan("com.zb.mapper")批量扫描就行

之后可以参考:
MybatisPlus学习总结(上)

1.5 整合Redis

  • SpringBoot Data Redis中提供了 RedisTemplateStringRedisTemplate,其中StringRedisTemplateRedisTemplate的子类,两个方法基本一致,不同之处主要体现在操作的数据类型不同
  • RedisTemplate中的两个泛型都是Object,意味着存储的key和value都可以是一个对象
  • StringRedisTemplate的两个泛型都是String,意味着StringRedisTemplate的key和value都只能是字符串。

注意: 使用RedisTemplate默认是将对象序列化到Redis中,所以放入的对象必须实现对象序列化接口

1、导入依赖:

<!--redis的场景依赖-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

spring-boot-starter-data-redis的自动配置: