mybatis通用mapper

深碍√TFBOYSˉ_ 2022-01-20 02:33 406阅读 0赞

###          从mybatis3.4.0开始加入了@Mapper注解，目的就是为了不再写mapper映射文件（那个xml写的是真的蛋疼。。。）。 ###

**例子：**

//UserDAO
    import org.apache.ibatis.annotations.Mapper;
    import org.apache.ibatis.annotations.Param;
    import org.apache.ibatis.annotations.Select;
    
    import entity.User;
    
    /**
     * 添加了@Mapper注解之后这个接口在编译时会生成相应的实现类
     * 
     * 需要注意的是：这个接口中不可以定义同名的方法，因为会生成相同的id
     * 也就是说这个接口是不支持重载的
     */
    @Mapper
    public interface UserDAO {
    
        @Select("select * from user where name = #{name}")
        public User find(String name);
    
        @Select("select * from user where name = #{name} and pwd = #{pwd}")
        /**
          * 对于多个参数来说，每个参数之前都要加上@Param注解，
          * 要不然会找不到对应的参数进而报错
          */
        public User login(@Param("name")String name, @Param("pwd")String pwd);
    }

**@Mapper中式没有@Component，无法被@ComponentScan扫描。所以需要通过@MapperScan进行扫描。**

### 下面用一种更简单的方法 ###

## **什么是通用Mapper** ##

通用Mapper就是为了解决单表增删改查，基于Mybatis的插件。开发人员不需要编写SQL，不需要在DAO中增加方法，只要写好实体类，就能支持相应的增删改查方法。

关于MyBatis，大部分人都很熟悉。MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。

不管是DDD（Domain Driven Design，领域驱动建模）还是分层架构的风格，都会涉及到对数据库持久层的操作，本文将会讲解Spring Boot集成MyBatis如何实现通用Mapper。

**优势:**

1.  无需xml文件和Dao 对应。
2.  无需指定xml 文件位置（因为就没有xml文件）。
3.  自带多种常用方法。

## 常用注解 ##

@Table 注解   
作用：建立实体类和数据库表之间的对应关系。  
默认规则：实体类类名首字母小写作为表名。Employee 类→employee 表。

用法：在@Table 注解的 name 属性中指定目标数据库表的表名

@Column 注解   
作用：建立实体类字段和数据库表字段之间的对应关系。  
默认规则：  
实体类字段：驼峰式命名  
数据库表字段：使用“\_”区分各个单词

用法：在@Column 注解的 name 属性中指定目标字段的字段名

@Id 注解   
通用 Mapper 在执行 xxxByPrimaryKey(key)方法时，有两种情况。  
情况 1：没有使用@Id 注解明确指定主键字段  
SELECT emp\_id,emp\_name,emp\_salary\_apple,emp\_age FROM tabple\_emp WHERE emp\_id = ?  
AND emp\_name = ? AND emp\_salary\_apple = ? AND emp\_age = ?  
之所以会生成上面这样的 WHERE 子句是因为通用 Mapper 将实体类中的所有  
字段都拿来放在一起作为联合主键。

情况 2：使用@Id 主键明确标记和数据库表中主键字段对应的实体类字段

@GeneratedValue 注解   
作用：让通用 Mapper 在执行 insert 操作之后将数据库自动生成的主键值回写到实体类对象中。

使用：

@Id
    @KeySql(useGeneratedKeys = true)
    private Long id;

或：

@Id
    @GeneratedValue(generator = "JDBC")
    private Long id;

@Transient 主键   
用于标记不与数据库表字段对应的实体类字段。  
@Transient  
private String otherThings;   //非数据库表中字段

## **传统Mybatis用法** ##

### Spring boot ###

引用基本的jar到pom

<dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.4.4</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <version>1.5.4.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <version>1.5.4.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.3.0</version>
    </dependency>

### sql 数据准备 ###

DROP TABLE IF EXISTS category;
    CREATE TABLE category (
      category_id   INT PRIMARY KEY,
      category_name VARCHAR (50) NOT NULL,
      description   VARCHAR (100)
    );
    DROP TABLE IF EXISTS product;
    CREATE TABLE product (
      product_id    INT PRIMARY KEY auto_increment,
      category_id   INT NOT NULL,
      product_name  VARCHAR (50) NOT NULL,
      price         DECIMAL
    );
    DELETE FROM category;
    INSERT INTO category (category_id, category_name, description) VALUES
      (1, 'Beverages', 'test'),
      (2, 'Condiments', 'test'),
      (3, 'Oil', 'test');
      DELETE FROM product;
    INSERT INTO product (product_id, category_id, product_name, price) VALUES
      (1, 1, 'Northwind Traders Chai', 18.0000),
      (2, 2, 'Northwind Traders Syrup', 7.5000),
      (3, 2, 'Northwind Traders Cajun Seasoning', 16.5000),
      (4, 3, 'Northwind Traders Olive Oil', 16.5000),
      (5, 3, 'Northwind Traders Olive Oil2', 16.5000);

### entity ###

public class Product {
        private Integer productID;
        private String productName;
        private BigDecimal price;
        private Integer categoryID;
        // get/set...
    }
    
    
    //SpringData
    @Table(name = "category")
    public class Category {
        @Id
        @Column(name = "category_id")
        private Integer categoryID;
        private String categoryName;
        private String description;
        // get /set...
    }

### Dao ###

这里的ProductDao是传统的mybatis的用法。

@Mapper
    public interface ProductDao {
        List<Product> getProducts();
    }

### mapper ###

传统mybatis 我们必须有个xml 文件和Dao 对应起来, tk.maybatis.mapper无需此文件。

<mapper namespace="com.github.wz2cool.demo.tk.mybatis.mapper.ProductDao">
        <select id="getProducts" resultType="com.github.wz2cool.demo.tk.mybatis.model.entity.table.Product">
            SELECT * FROM product
        </select>
    </mapper>

### 设置扫描包 ###

@SpringBootApplication
    @MapperScan(basePackages = "com.github.wz2cool.demo.tk.mybatis.mapper")
    public class TestApplication {
        public static void main(String[] args) {
            SpringApplication.run(TestApplication.class, args);
        }
    }

### application.properies ###

注意这里的配置只是针对我们传统mybatis配置，对于tk.maybatis.mapper可以省略这里的配置。

mybatis.type-aliases-package=com.github.wz2cool.demo.tk.mybatis.mapper
    mybatis.mapper-locations=classpath:com.github.wz2cool.demo.tk.mybatis.mapper/*.xml

## **tk.mybatis.mapper 用法** ##

### 添加引用 ###

需要多添加两个引用 (ps:曾经少了一个mapper-spring-boot-starter,报错死活找不到为什么--!!!)

<dependency>
        <groupId>tk.mybatis</groupId>
        <artifactId>mapper</artifactId>
        <version>3.4.2</version>
    </dependency>
    
    <dependency>
        <groupId>tk.mybatis</groupId>
        <artifactId>mapper-spring-boot-starter</artifactId>
        <version>1.1.3</version>
    </dependency>

### 继承通用mapper ###

嗯 是的没有xml 文件。

public interface CategoryDao extends Mapper<Category> {
    }

### 测试调用 ###

dao 里面自带很多方法，比如 selectAll(), insert().

@RunWith(SpringRunner.class)
    @SpringBootTest
    @ContextConfiguration(classes = TestApplication.class)
    public class SimpleTkMapperTest {
    
        @Autowired
        private CategoryDao categoryDao;
    
        @Test
        public void selectAllTest() {
            List<Category> categories = categoryDao.selectAll();
            assertEquals(true, categories.size() > 0);
        }
    
        @Test
        public void insertTest() {
            Category newCategory = new Category();
            newCategory.setCategoryID(1000);
            newCategory.setCategoryName("test");
            newCategory.setDescription("for test");
            int result = categoryDao.insert(newCategory);
            assertEquals(1, result);
        }
    }

# #