最近在学习使用Springboot,所以需要搭建一个基本框架,在网上也看了其他大神的搭建步骤,不过每个人在搭建的过程中总会遇见一些奇怪的问题,所以还是记录一下心得体会,如有不对请指正。
一.构建SpringBoot项目
-
本项目使用的环境工具:IDEA+JDK8+MYSQL
-
搭建步骤如下:
打开IDEA工具新建项目
配置1,2这两个地方,设置自己想要的名字然后下一步
因为我需要构建web工程,所以这里需要勾选
SQL这里选择如下:
然后下一步点击完成
3. springboot项目基础框架就搭建好了,然后添加启动需要的基本配置和类a) 首先配置好application.properties
mybatis.typeAliasesPackage=com.demo.vo
mybatis.mapperLocations=classpath:mappers/*.xml
spring.datasource.url=jdbc:mysql://localhost:3306/weibo
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
b)写一个简单的Controller
@RestController
public class DemoController {
@RequestMapping("/name")
public User getUserName() {
User user = new User();
user.setName("test");
return user;
}
}
c)写一个实体
public class User {
private String name;
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
}
整体结构如下:
4. 启动主程序
5. 启动完成后如果没有报错则表明项目搭建成功,可以测试项目了。
IDEA非常好用的一点就是自带测试工具,而不用启动浏览器来测试,我习惯于Restful的风格测试,所以测试方法如下打开后弹出如下界面在Path中填写我们Controller类中的路径测试我们的方法是否生效,本项目中的方法是getUserName(),所以Path处需要写"name"(此处根据自己项目中写的什么填什么),然后点击左上方的绿色按钮运行Response中出现结果则表明程序运行正常。到此我们的SpringBoot项目搭建完成。
二. 添加mybatis组件
6. 本项目采用druid,所以pom.xml中需要添加相应配置
<!-- alibaba的druid数据库连接池 -->
<!-- https://mvnrepository.com/artifact/com.alibaba/druid-spring-boot-starter -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.10</version>
</dependency>
- 相应的application.properties配置文件中也需要加一句
# 使用druid数据源
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
- 使用mybatis generator自动生成代码
a) 需要在pom.xml中添加mybatis generator生成插件
<!-- mybatis generator 自动生成代码插件 -->
<plugin>
<!--Mybatis-generator插件,用于自动生成Mapper和POJO-->
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
<overwrite>true</overwrite>
<verbose>true</verbose>
</configuration>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
</plugin>
最终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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.demo</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>demo</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.38</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- alibaba的druid数据库连接池 -->
<!-- https://mvnrepository.com/artifact/com.alibaba/druid-spring-boot-starter -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.10</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<!-- mybatis generator 自动生成代码插件 -->
<plugin>
<!--Mybatis-generator插件,用于自动生成Mapper和POJO-->
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.2</version>
<configuration>
<configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
<overwrite>true</overwrite>
<verbose>true</verbose>
</configuration>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.2</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
b) 编写Mybatis-generator配置文件generatorConfig.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!-- 指定数据库驱动的jdbc驱动jar包的位置 -->
<classPathEntry location="E:/JAR/mysql-connector-java-5.1.5-bin.jar" />
<!-- context 是逆向工程的主要配置信息 -->
<!-- id:起个名字 -->
<!-- targetRuntime:设置生成的文件适用于那个 mybatis 版本 -->
<context id="default" targetRuntime="MyBatis3">
<!--optional,旨在创建class时,对注释进行控制-->
<commentGenerator>
<property name="suppressDate" value="true" />
<!-- 是否去除自动生成的注释 true:是 : false:否 -->
<property name="suppressAllComments" value="true" />
</commentGenerator>
<!--jdbc的数据库连接-->
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/weibo?characterEncoding=UTF-8"
userId="root"
password="root">
</jdbcConnection>
<!--非必须,类型处理器,在数据库类型和java类型之间的转换控制-->
<javaTypeResolver>
<!-- 默认情况下数据库中的 decimal,bigInt 在 Java 对应是 sql 下的 BigDecimal 类 -->
<!-- 不是 double 和 long 类型 -->
<!-- 使用常用的基本类型代替 sql 包下的引用类型 -->
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<!-- targetPackage:生成的实体类所在的包 -->
<!-- targetProject:生成的实体类所在的硬盘位置 -->
<javaModelGenerator targetPackage="com.demo.vo"
targetProject=".\src\main\java">
<!-- 是否允许子包 -->
<property name="enableSubPackages" value="false" />
<!-- 是否对modal添加构造函数 -->
<property name="constructorBased" value="true" />
<!-- 是否清理从数据库中查询出的字符串左右两边的空白字符 -->
<property name="trimStrings" value="true" />
<!-- 建立modal对象是否不可改变 即生成的modal对象不会有setter方法,只有构造方法 -->
<property name="immutable" value="false" />
</javaModelGenerator>
<!-- targetPackage 和 targetProject:生成的 mapper 文件的包和位置 -->
<sqlMapGenerator targetPackage="mappers"
targetProject=".\src\main\resources">
<!-- 针对数据库的一个配置,是否把 schema 作为字包名 -->
<property name="enableSubPackages" value="false" />
</sqlMapGenerator>
<!-- targetPackage 和 targetProject:生成的 interface 文件的包和位置 -->
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.demo.dao" targetProject=".\src\main\java">
<!-- 针对 oracle 数据库的一个配置,是否把 schema 作为字包名 -->
<property name="enableSubPackages" value="false" />
</javaClientGenerator>
<table tableName="t_user" domainObjectName="User"
enableCountByExample="false" enableUpdateByExample="false"
enableDeleteByExample="false" enableSelectByExample="false"
selectByExampleQueryId="false">
</table>
</context>
</generatorConfiguration>
配置文件中的路径需要根据自己路径配置正确即可
到此配置mybatis generator自动生成代码的方法就算完成,下面开始利用IDEA工具自动生成代码点击IDEA右上侧的Maven Projects>Plugins>mybatis-generator>mybatis-generator:generate
双击mybatis-generator:generate后就可以自动生成所需代码了。生成后的项目结构如下:
三. 填充MVC框架
- 基本代码生成好后就可以正式开始写代码了。首先添加sercice层代码
public interface UserService {
User selectByPrimaryKey(Integer id);
}
@Service
public class UserServiceImpl implements UserService {
@Resource
private UserMapper userMapper;
@Override
public User selectByPrimaryKey(Integer id) {
return userMapper.selectByPrimaryKey(id);
}
}
- 添加controller层代码
@ResponseBody
@RequestMapping(value = "/getUserById/{id}",method = RequestMethod.GET)
public User getSelectByPrimaryKey( @PathVariable("id") int id){
return userService.selectByPrimaryKey(id);
}
整体代码结构如下:
启动主程序查看项目是否正常
发现启动报错,找不到UserMapper.java
这是为什么呢?原来是因为程序没有扫描到dao层,所以需要在主程序DemoApplication.java 类中添加一个配置
添加后项目启动正常。
最后关键的一步,测试程序是否正常调用数据库,按照上面的测试方法测试我们的程序
当然首先数据里面的有值才能查询出来,大家可以简单的添加两条值测试即可。整个项目大功告成,大家可以继续填充该项目了。
我把该项目的源码也一并放在云盘
https://pan.baidu.com/s/1t4pcFoLdmFNx0xGVQ4xNDw
供大家参考。