springboot搭建项目环境以及整合其他技术

文章目录

一.首先介绍4款插件:lombok和JBLSpringBootAppGen、mybatisX、easyCode
- 1.1 lombok
- 1.2 JBLSpringBootAppGen
- 1.3 MybatisX插件
- 1.4 easyCode插件
二.springboot整合其他技术
- 2.1 使用idea快速创建SpringBoot项目
- 2.2 SpringBoot整合Mybatis
- - 2.2.1 添加Mybatis的起步依赖
  - 2.2.2 添加数据库驱动坐标
  - 2.2.3 添加数据库连接信息
  - 2.2.4 创建user表
  - 2.2.5 创建实体Bean
  - 2.2.6 编写Mapper
  - 2.2.7 配置Mapper映射文件
  - 2.2.8 在application.properties中添加mybatis的信息(此时spring还不知道mybatis的信息,需要通过该配置告知spring)
  - 2.2.9 编写测试Controller
  - 2.2.10 测试
- 2.3 SpringBoot整合Junit
- - 2.3.1 添加Junit的起步依赖(使用springboot联网方式创建项目(Spring Initializr)时默认已经添加了该依赖
  - 2.3.2 编写测试类
- 2.4 SpringBoot整合Spring Data JPA
- - 2.4.1 添加Spring Data JPA的起步依赖
  - 2.4.2 添加数据库驱动依赖
  - 2.4.3 在application.properties中配置数据库和jpa的相关属性
  - 2.4.4 创建实体配置实体
  - 2.4.5 编写UserRepository
  - 2.4.6 编写测试类(springboot默认已集成junit依赖包)
  - 2.4.7 控制台打印信息
- 2.5 SpringBoot整合Redis
- - 2.5.1 添加redis的起步依赖
  - 2.5.2 配置redis的连接信息
  - 2.5.3 注入RedisTemplate单元测试redis操作
- 2.6 SpringBoot集成Swagger2

一.首先介绍4款插件:lombok和JBLSpringBootAppGen、mybatisX、easyCode

1.1 lombok

我们编写pojo时，经常需要编写构造函数和getter、setter方法，属性多的时候，就非常浪费时间，使用lombok插件
可以解决这个问题：
在IDEA中安装lombok插件；不安装插件在IDEA中使用lombok的注解虽然编译能通过，但是源码会报错。所以为了
让IDEA更好的辨别lombok注解则才安装插件。

需要在maven工程中的 pom.xml 文件引入依赖：

<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId>
</dependency>

然后可以在Bean上使用：
@Data ：自动提供getter和setter、hashCode、equals、toString等方法
@Getter：自动提供getter方法
@Setter：自动提供setter方法
@Slf4j：自动在bean中提供log变量，其实用的是slf4j的日志功能。

1.2 JBLSpringBootAppGen

在应用spring boot工程的时候；一般情况下都需要创建启动引导类Application.java和application.yml配置文件，而
且内容都是一样的；为了便捷可以安装一个IDEA的插件 JBLSpringBootAppGen 在项目上右击之后可以自动生成启
动引导类Application.java和application.yml配置文件。

注:使用插件可以快速创建引导类和配置信息.在要创建引导类的模块名右键点击JBLSpringBootAppGen.

1.3 MybatisX插件

可以快速定位到dao层对应的sql语句，安装成功会有一个小鸟的图标

1.4 easyCode插件

快速生成代码插件：在idea中连接数据库后，根据配置好的模板可以快速生成代码。
【补充】idea连接数据库：

首先检查是否有mysql驱动，没有驱动要先添加，否则无法连接数据库。选择一个版本的驱动进行安装。

选择表，根据配置好的模板文件，预览生成的代码；

二.springboot整合其他技术

2.1 使用idea快速创建SpringBoot项目

1.首先创建一个空工程(看情况,随意),然后在工程下创建模块如下:

2.注意此处的最后一项的包的层级,记着把最后一项默认的com.fightting.springboot_mybatis改成com.fightting
3.
4.
5.删除自动生成的三个无关的文件
6.建好之后的整体包层级环境

2.2 SpringBoot整合Mybatis

步骤:

1.添加Mybatis的起步依赖

2.添加数据库驱动坐标

3.添加数据库连接信息

4.创建数据库表(user表)

5.创建实体Bean

6.编写Mapper(Mapper接口)

7.配置Mapper映射文件(用于映射表和实体类的映射关系)

8.在application.properties中添加mybatis的信息

9.编写测试Controller

10.测试

先看一下整体的项目结构

2.2.1 添加Mybatis的起步依赖

<!--mybatis起步依赖-->
<dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>1.1.1</version>
</dependency>

2.2.2 添加数据库驱动坐标

<!-- MySQL连接驱动 -->
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId>
</dependency>

2.2.3 添加数据库连接信息

在application.properties中添加数据库的连接信息
注意:使用springboot联网方式创建项目(Spring Initializr)时,数据库驱动如果使用com.mysql.jdbc.Driver时会报一个错误提示,要求更改成新的数据库驱动,com.mysql.cj.jdbc.Driver,并且对于时间域也有要求,此处是正确的配置方式

#DB Configuration:
spring.datasource.driverClassName=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/springboot_mybatis?serverTimezone=UTC&useSSL=false
spring.datasource.username=root
spring.datasource.password=root

对比之前的配置如下:

#DB Configuration:
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/springboot_mybatis?useUnicode=true&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=root

按照旧版配置会报如下错误

2.2.4 创建user表

在springboot_mybatis数据库中创建user表

-- ----------------------------
-- Table structure for `user`
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (`id` int(11) NOT NULL AUTO_INCREMENT,`username` varchar(50) DEFAULT NULL,`password` varchar(50) DEFAULT NULL,`name` varchar(50) DEFAULT NULL,PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=10 DEFAULT CHARSET=utf8;-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES ('1', 'zhangsan', '123', '张三');
INSERT INTO `user` VALUES ('2', 'lisi', '123', '李四');

2.2.5 创建实体Bean

在com.fightting包下创建domain包,在domain包下创建该实体类

import lombok.Data;@Data
public class User {// 主键private Integer id;// 用户名private String username;// 密码private String password;// 姓名private String name;//此处简化了getter和setter方法 .. ..//方便打印可以重写toString()方法//上面两步已通过lombok插件并使用@Data注解简化完成//lombok插件的@Data ：自动提供getter和setter、hashCode、equals、toString等方法
}

2.2.6 编写Mapper

在com.fightting下创建mapper包,在该包下创建该UserMapper接口类

@Mapper
public interface UserMapper {public List<User> queryUserList();
}

注意：@Mapper标记该类是一个mybatis的mapper接口，可以被spring boot自动扫描到spring上下文中

2.2.7 配置Mapper映射文件

在src\main\resources\mapper路径下加入UserMapper.xml配置文件"(先创建mapper包,右键新建 file文件),该映射文件中的sql语句标签要和mapper接口中的方法名对应

<?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.fightting.mapper.UserMapper"><select id="queryUserList" resultType="user">select * from user</select>
</mapper>

2.2.8 在application.properties中添加mybatis的信息(此时spring还不知道mybatis的信息,需要通过该配置告知spring)

#spring集成Mybatis环境
#pojo别名扫描包
mybatis.type-aliases-package=com.fightting.domain
#加载Mybatis映射文件
mybatis.mapper-locations=classpath:mapper/*Mapper.xml

2.2.9 编写测试Controller

@Controller
public class MapperController {@Autowiredprivate UserMapper userMapper;@RequestMapping("/queryUser")@ResponseBodypublic List<User> queryUser(){List<User> users = userMapper.queryUserList();return users;}}

2.2.10 测试

2.3 SpringBoot整合Junit

通过Junit单元测试可以不用必须通过controller利用web客户端测试(不用启动项目),通过单元测试就可以实现.
先看一下test部分的整体包层级关系

2.3.1 添加Junit的起步依赖(使用springboot联网方式创建项目(Spring Initializr)时默认已经添加了该依赖

<!--测试的起步依赖-->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope>
</dependency>

2.3.2 编写测试类

package com.fightting;import com.fightting.domain.User;
import com.fightting.mapper.UserMapper;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;import java.util.List;@RunWith(SpringRunner.class)
@SpringBootTest(classes = SpringbootMybatisApplication.class)//引导类的字节码对象
public class MybatisTest {@Autowiredprivate UserMapper userMapper;@Testpublic void test() {List<User> users = userMapper.queryUserList();System.out.println(users);}
}

其中，

SpringRunner继承自SpringJUnit4ClassRunner，使用哪一个Spring提供的测试测试引擎都可以

public final class SpringRunner extends SpringJUnit4ClassRunner

@SpringBootTest的属性指定的是引导类的字节码对象

扩展:

@RunWith就是一个运行器
@RunWith(JUnit4.class)就是指用JUnit4来运行
@RunWith(SpringJUnit4ClassRunner.class),让测试运行于Spring测试环境

3 .控制台打印信息

2.4 SpringBoot整合Spring Data JPA

先看一下整体环境的包层级

2.4.1 添加Spring Data JPA的起步依赖

<!-- springBoot JPA的起步依赖 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

2.4.2 添加数据库驱动依赖

<!-- MySQL连接驱动 -->
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId>
</dependency>

2.4.3 在application.properties中配置数据库和jpa的相关属性

#DB Configuration:
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/springboot_mybatis?serverTimezone=UTC&useSSL=false
spring.datasource.username=root
spring.datasource.password=root#JPA Configuration:
spring.jpa.database=MySQL
spring.jpa.show-sql=true
spring.jpa.generate-ddl=true
spring.jpa.hibernate.ddl-auto=update
spring.jpa.hibernate.naming_strategy=org.hibernate.cfg.ImprovedNamingStrategy

2.4.4 创建实体配置实体

@Entity//Springdata Jpa的注解必须与@Id注解 结合使用
@Data
public class User {// 主键@Id@GeneratedValue(strategy = GenerationType.IDENTITY)private Long id;// 用户名private String username;// 密码private String password;// 姓名private String name;//setter和getter以及toString()方法已由lombok的@Data注解简化替代
}

2.4.5 编写UserRepository

mybatis和SpringdataJpa的映射接口类习惯叫法:
mybatis:mapper/UserMapper
SpringdataJpa:repository/UserRepository

public interface UserRepository extends JpaRepository<User,Integer>{public List<User> findAll();
}

2.4.6 编写测试类(springboot默认已集成junit依赖包)

在test/java/com/fightting下新建JpaTest测试类

@RunWith(SpringRunner.class)
@SpringBootTest(classes = SpringbootJpaApplication.class)
public class JpaTest {//测试谁就注入谁@Autowiredprivate UserRepository userRepository;@Testpublic void test(){List<User> users =userRepository.findAll();System.out.println(users);}
}

2.4.7 控制台打印信息

注意：如果是jdk9，执行报错如下：

原因：jdk缺少相应的jar

解决方案：手动导入对应的maven坐标，如下：

<!--jdk9需要导入如下坐标-->
<dependency><groupId>javax.xml.bind</groupId><artifactId>jaxb-api</artifactId><version>2.3.0</version>
</dependency>

2.5 SpringBoot整合Redis

本地主机上的windows版的redis直接双击server.exe就启动了redis服务器

2.5.1 添加redis的起步依赖

<!-- 配置使用redis启动器 -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

2.5.2 配置redis的连接信息

在application.properties文件中加入redis连接信息

#Redis
spring.redis.host=127.0.0.1
spring.redis.port=6379

2.5.3 注入RedisTemplate单元测试redis操作

@RunWith(SpringRunner.class)
@SpringBootTest(classes = SpringbootJpaApplication.class)
public class RedisTest {@Autowiredprivate UserRepository userRepository;//springboot导入redis依赖坐标之后就会自动创建redisTemplate模板,使用时直接注入@Autowiredprivate RedisTemplate<String, String> redisTemplate;@Testpublic void test() throws JsonProcessingException {//1.从redis缓存中获得指定的数据,数据的形式json字符串String userListData = redisTemplate.boundValueOps("user.findAll").get();//2.判断redis中是否存在数据//2.1如果redis中没有数据的话if(null==userListData){//查询数据库获得数据,此处借助springdataJpa的uerRepositoryList<User> all = userRepository.findAll();//将List集合转换成json格式字符串,使用jackson进行转换ObjectMapper om = new ObjectMapper();userListData = om.writeValueAsString(all);//将数据存储到redis中，下次在查询直接从redis中获得数据，不用在查询数据库redisTemplate.boundValueOps("user.findAll").set(userListData);System.out.println("===============从数据库获得数据===============");}else{System.out.println("===============从redis缓存中获得数据===============");}System.out.println(userListData);}
}

2.6 SpringBoot集成Swagger2

SwaggerConfig
@Configuration
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage(“cn.itcast.heima.springdemo”))
.build()
.apiInfo(new ApiInfoBuilder().title(“测试”).description(“测试”).contact(new Contact(“”, “”, “”)).build());
}
}

Pom：

<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.7.0</version>
</dependency>
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.7.0</version>
</dependency>

引导类增加：
@EnableSwagger2