SpringBoot - mapper，mapperscan；ORM操作数据库；自动生成代码；事务

Posted 2022-05-23 MinggeQingchun

ORM（Object-Relational Mapping，对象关系映射）是一种为了解决程序的面向对象模型与数据库的关系模型互不匹配问题的技术；简单的说，ORM是通过使用描述对象和数据库之间映射的元数据（在Java中可以用XML或者是注解），将程序中的对象自动持久化到关系数据库中或者将关系数据库表中的行转换成Java对象，其本质上就是将数据从一种形式转换到另外一种形式

首先我们使用mysql创建好一个数据库，以及表student

一、@Mapper

1、pom.xml中导入 mybatis和mysql 的依赖，以及插件

<dependencies>
        <!--web起步依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--mybatis起步依赖-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.2</version>
        </dependency>

        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

pom.xml中指定 把resources目录中的文件 ， 编译到目标目录中  

    <build>
        <!--resources插件-->
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>
    </build>

2、application.yml配置中加载mysql驱动

server:
  port: 8081
  servlet:
    context-path: /orm

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/springbootdb?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
    username: root
    password: 123456

3、创建student实体类

public class Student 

    private Integer id;
    private String name;
    private Integer age;

    public Integer getId() 
        return id;
    

    public void setId(Integer id) 
        this.id = id;
    

    public String getName() 
        return name;
    

    public void setName(String name) 
        this.name = name;
    

    public Integer getAge() 
        return age;
    

    public void setAge(Integer age) 
        this.age = age;
    

    @Override
    public String toString() 
        return "Student" +
                "id=" + id +
                ", name='" + name + '\\'' +
                ", age=" + age +
                '';
    

4、创建 dao 以及 mapper.xml文件

@Mapper：放在dao接口的上面， 每个接口都需要使用这个注解

/**
 * @Mapper：告诉MyBatis这是dao接口，创建此接口的代理对象。
 *     位置：在类的上面
 */
@Mapper
public interface StudentDao 

    Student selectById(@Param("stuId") Integer id);

<mapper namespace="com.company.dao.StudentDao">
    
    <!--定义sql语句-->
    <select id="selectById" resultType="com.company.model.Student">
        select id,name,age from student where id=#stuId
    </select>

</mapper>

 5、创建service接口以及实现类

@Service
public class StudentServiceImpl implements StudentService 

    @Autowired
    private StudentDao studentDao;

    @Override
    public Student queryStudent(Integer id) 
        Student student = studentDao.selectById(id);
        return student;
    

6、创建controller运行项目测试

@Controller
public class StudentController 

    @Resource
    private StudentService studentService;

    @RequestMapping("/student/query")
    @ResponseBody
    public String queryStudent(Integer id)
        Student student = studentService.queryStudent(id);
        return student.toString();
    

二、@MapperScan

我们使用@Mapper注解 ，需要在每个Dao 接口都加入注解。

这时可以在主类上添加注解包扫描：@MapperScan("com.xx.dao")

在pom.xml文件中添加插件

<!--resources插件-->
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
        </resources>

启动类上添加注解 @MapperScan

/**
 * @MapperScan: 找到Dao接口和Mapper文件
 *     basePackages：Dao接口所在的包名
 */
@MapperScan(basePackages = "com.company.dao","com.company.mapper")
@SpringBootApplication
public class Springboot13MapperscanApplication 

    public static void main(String[] args) 
        SpringApplication.run(Springboot13MapperscanApplication.class, args);
    

三、Mapper文件和Dao接口分离

把Mapper文件放在resources目录下

（1）在resources目录中创建子目录 ，如 mapper

（2）把mapper文件放到 mapper目录中

（3）在application.yml文件中，指定mapper文件的目录

server:
  port: 8081
  servlet:
    context-path: /orm

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/springbootdb?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
    username: root
    password: admin123

# MyBatis配置
#指定mapper文件的位置
mybatis:
# 配置mapper的扫描，找到所有的mapper.xml映射文件
  mapperLocations: classpath*:mapper/*.xml
  #指定mybatis的日志
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

（4）在pom.xml中指定 把resources目录中的文件 ， 编译到目标目录中

<!--resources插件-->
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.*</include>
                </includes>
            </resource>
        </resources>

（5）启动类中扫描包

/**
 * @MapperScan: 找到Dao接口和Mapper文件
 *     basePackages：Dao接口所在的包名
 */
@MapperScan(basePackages = "com.company.dao","com.company.mapper")
@SpringBootApplication
public class Springboot14MapperResourcesApplication 

    public static void main(String[] args) 
        SpringApplication.run(Springboot14MapperResourcesApplication.class, args);
    

四、自动生成代码

将GeneratorMapper.xml文件放在pom.xml同级目录下 

修改 GeneratorMapper.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驱动包所在位置，指定到你本机的完整路径 -->
    <classPathEntry location="D:\\JDK\\mysql-connector-java-8.0.28.jar"/>

    <!-- 配置table表信息内容体，targetRuntime指定采用MyBatis3的版本 -->
    <context id="tables" targetRuntime="MyBatis3">

        <!-- 抑制生成注释，由于生成的注释都是英文的，可以不让它生成 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true" />
        </commentGenerator>

        <!-- 配置数据库连接信息 -->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/springboot?useUnicode=true&amp;characterEncoding=UTF-8&amp;serverTimezone=GMT%2B8"
                        userId="root"
                        password="admin123456">
        </jdbcConnection>

        <!-- 生成model类，targetPackage指定model类的包名， targetProject指定生成的model放在eclipse的哪个工程下面-->
        <javaModelGenerator targetPackage="com.company.model"
                            targetProject="D:\\Java\\JavaProject\\springboot-demo\\springboot-15-gen-transactional\\src\\main\\java">
            <property name="enableSubPackages" value="false" />
            <property name="trimStrings" value="false" />
        </javaModelGenerator>

        <!-- 生成MyBatis的Mapper.xml文件，targetPackage指定mapper.xml文件的包名， targetProject指定生成的mapper.xml放在eclipse的哪个工程下面 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>

        <!-- 生成MyBatis的Mapper接口类文件,targetPackage指定Mapper接口类的包名， targetProject指定生成的Mapper接口放在eclipse的哪个工程下面 -->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.company.dao" targetProject="src/main/java">
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>

        <!-- 数据库表名及对应的Java模型类名 -->
        <table tableName="student" domainObjectName="Student"
               enableCountByExample="false"
               enableUpdateByExample="false"
               enableDeleteByExample="false"
               enableSelectByExample="false"
               selectByExampleQueryId="false"/>


    </context>

</generatorConfiguration>

在pom.xml文件中加入插件

<build>
        <!--处理资源目录-->
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.*</include>
                </includes>
            </resource>
        </resources>

        <plugins>
            <!--mybatis代码自动生成插件-->
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.6</version>
                <configuration>
                    <!--配置文件的位置: 在项目的根目录下，和src评级的-->
                    <configurationFile>GeneratorMapper.xml</configurationFile>
                    <verbose>true</verbose>
                    <overwrite>true</overwrite>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

 双击右边 Maven中的Plugins 中的自动生成代码插件即可

五、事务 

Spring Boot 使用事务非常简单，底层依然采用的是 Spring 本身提供的事务管理

1、在入口类中使用注解 @EnableTransactionManagement 开启事务支持

2、在访问数据库的 Service 方法上添加注解 @Transactional 即可

@Service
public class StudentServiceImpl implements StudentService 

    @Autowired
    private StudentMapper studentDao;

    /**
     * @Transactional: 表示方法的有事务支持
     *       默认：使用库的隔离级别， REQUIRED 传播行为； 超时时间  -1
     *       抛出运行时异常，回滚事务
     */
    @Transactional
    @Override
    public int addStudent(Student student) 
        System.out.println("业务方法addStudent");
        int rows  =  studentDao.insert(student);
        System.out.println("执行sql语句");

        //抛出一个运行时异常， 目的是回滚事务
        //int m   = 10 / 0 ;

        return rows;