MyBatis之手动映射&log4j

前面的学习中XxxMapper.xml文件中SQL语句查询结果都是依赖resultType进行自动映射的

什么是自动映射呢?

将数据库表中查询出的结果按照字段名将值封装至对应的实体类对象属性中

所以这里也就要求数据库表中的字段名称与实体类中定义的属性名称一致

否则,无法映射成功,主要体现就是该实体类对象的该属性为null

而恰巧数据库表字段命名规范有时就与java属性名命名规范不一致

为此有三种方案解决这种问题:

①在命名时尽量保证java属性名与数据库字段名一致

②sql语句中需要为字段起别名,别名即为java代码中的属性名称

③使用手动映射

这里主要学习下如何做到手动映射!

一.案例展示

1.测试准备

①mysql数据库一枚

②database名为batistest且表名为order

③项目工程

2.代码展示

***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.howie</groupId>
    <artifactId>mybatis_manual_mapping</artifactId>
    <version>1.0-SNAPSHOT</version>
    
    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>

    <dependencies>
        <!--单元测试-->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.46</version>
        </dependency>
        <!--mybatis-->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.5</version>
        </dependency>
        <!--log4j-->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    </dependencies>
</project>

***bean.properties

OrderService=com.howie.service.impl.OrderServiceImpl

***db.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/batistest?characterEncoding=utf-8
jdbc.username=root
jdbc.password=root

***log4j.properties

#log4j日志级别如下：
#A：off     最高等级，用于关闭所有日志记录。
#B：fatal   指出每个严重的错误事件将会导致应用程序的退出。
#C：error   指出虽然发生错误事件，但仍然不影响系统的继续运行。
#D：warn    表明会出现潜在的错误情形。
#E：info    一般和在粗粒度级别上，强调应用程序的运行全程。
#F：debug   一般用于细粒度级别上，对调试应用程序非常有帮助。
#G：all     最低等级，用于打开所有日志记录。
#但log4j只建议使用4个级别，优先级从高到低分别是:
#error>warn>info>debug
log4j.rootLogger=debug,systemOut,logFile
#输出到控制台
log4j.appender.systemOut=org.apache.log4j.ConsoleAppender
log4j.appender.systemOut.layout=org.apache.log4j.PatternLayout
log4j.appender.systemOut.layout.ConversionPattern=[%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n
log4j.appender.systemOut.Target=System.out
#输出到文件
log4j.appender.logFile=org.apache.log4j.FileAppender
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
log4j.appender.logFile.layout.ConversionPattern=[%-5p][%-22d{yyyy/MM/dd HH:mm:ssS}][%l]%n%m%n
log4j.appender.logFile.File=E:/log/log4j.log
log4j.appender.logFile.Encoding=UTF-8
#将日志输记录到MySQL数据库
#log4j.appender.logDB = org.apache.log4j.jdbc.JDBCAppender
#log4j.appender.logDB.layout = org.apache.log4j.PatternLayout
#log4j.appender.logDB.Driver = com.mysql.jdbc.Driver
#log4j.appender.logDB.URL = jdbc:mysql://localhost:3306/log4j?characterEncoding=utf-8
#log4j.appender.logDB.User = root
#log4j.appender.logDB.Password = root
#log4j.appender.logDB.Sql = INSERT INTO t_log4j(project_name,create_date,level,category,file_name,thread_name,line,all_category,message)values('mybatis','%d{yyyy-MM-ddHH:mm:ss}','%p','%c','%F','%t','%L','%l','%m')
#若出现问题：Log4j: ERROR Failed to load driver, java.lang.ClassNotFoundException: com.mysql.jdbc.Driver
#解决方法：将log4j.properties 中每行后面的空格都删除就解决了.

***SqlMapConfig.xml

<?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>

    <!--
        从外部文件db.properties读取数据库连接信息
    -->
    <properties resource="db.properties"/>

    <!--配置log4j日志-->
    <settings>
        <setting name="logImpl" value="LOG4J"/>
    </settings>

    <!--批量起别名-->
    <typeAliases>
        <package name="com.howie.pojo"/>
    </typeAliases>

    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <!--获取db文件中的数据-->
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>

    <!--批量扫描mapper-->
    <mappers>
        <!--<mapper resource="XxxMapper.xml"/>-->
        <package name="com.howie.mapper"/>
    </mappers>
</configuration>

***OrderMapper.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.howie.mapper.OrderMapper">
    <!--是否开启二级缓存(开启,则打开注释)-->
    <!--<cache/>-->

    <!--查询所有订单-->
    <select id="queryOrders" resultMap="orderResultMap">
        select * from `order`
    </select>
    <!--手动映射-->
    <resultMap id="orderResultMap" type="Order">
        <id column="id" property="id"/>
        <id column="user_id" property="userId"/>
        <id column="number" property="number"/>
        <id column="createtime" property="createtime"/>
        <id column="note" property="note"/>
    </resultMap>
</mapper>

***BeanFactory.java

package com.howie.utils;


import org.apache.ibatis.session.SqlSession;

import java.lang.reflect.Constructor;
import java.util.ResourceBundle;

/**
 *  Bean工厂对象
 *  方法:
 *    传递接口,传递的是接口的class文件对象
 *    返回实现类的对象
 *
 *    泛型: 本身没有类型,未知的数据类型
 *    调用的时候,传递什么,就是什么类型
 */
public class BeanFactory {
    public static <T>T newInstance(Class<T> clazz){
        //获取传递的接口名
        String name = clazz.getSimpleName();
        //读取配置文件
        ResourceBundle resourceBundle = ResourceBundle.getBundle("bean");
        String className = resourceBundle.getString(name);
        //反射创建对象
        try {
            return (T)Class.forName(className).newInstance();
        }catch (Exception ex){
            ex.printStackTrace();
        }
        return null;
    }

    /**
     *  带参构造
     * @param clazz
     * @param sqlSession
     * @param <T>
     * @return
     */
    public static <T>T newInstance(Class<T> clazz, SqlSession sqlSession){
        //获取传递的接口名
        String name = clazz.getSimpleName();
        //读取配置文件
        ResourceBundle resourceBundle = ResourceBundle.getBundle("bean");
        String className = resourceBundle.getString(name);
        //获取带参构造函数
        try {
            Constructor constructor = Class.forName(className).getConstructor(SqlSession.class);
            Object[] params = {sqlSession};
            //反射创建对象
            return (T)constructor.newInstance(params);
        }catch (Exception ex){
            ex.printStackTrace();
        }
        return null;
    }
}

***Order.java

package com.howie.pojo;

import java.util.Date;

/**
 * @Author weihuanwen
 * @Date 2019/8/12 11:23
 * @Version 1.0
 */
public class Order {
    private int id;
    private int userId;
    private String number;
    private Date createtime;
    private String note;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public int getUserId() {
        return userId;
    }

    public void setUserId(int userId) {
        this.userId = userId;
    }

    public String getNumber() {
        return number;
    }

    public void setNumber(String number) {
        this.number = number;
    }

    public Date getCreatetime() {
        return createtime;
    }

    public void setCreatetime(Date createtime) {
        this.createtime = createtime;
    }

    public String getNote() {
        return note;
    }

    public void setNote(String note) {
        this.note = note;
    }

    @Override
    public String toString() {
        return "Order{" +
                "id=" + id +
                ", userId=" + userId +
                ", number='" + number + '\'' +
                ", createtime=" + createtime +
                ", note='" + note + '\'' +
                '}';
    }
}

***OrderMapper.java

package com.howie.mapper;

import com.howie.pojo.Order;

import java.util.List;

/**
 * @Author weihuanwen
 * @Date 2019/8/12 11:24
 * @Version 1.0
 */
public interface OrderMapper {

    /**
     * 查询所有的订单
     * @return
     */
    List<Order> queryOrders();
}

***OrderService.java

package com.howie.service;

import com.howie.pojo.Order;

import java.util.List;

/**
 * @Author weihuanwen
 * @Date 2019/8/12 11:34
 * @Version 1.0
 */
public interface OrderService {

    /**
     * 查询所有的订单
     * @return
     */
    List<Order> queryOrders();
}

***OrderController.java

package com.howie.controller;

import com.howie.pojo.Order;
import com.howie.service.OrderService;
import com.howie.utils.BeanFactory;
import org.junit.Test;

import java.util.List;

/**
 * @Author weihuanwen
 * @Date 2019/8/12 11:41
 * @Version 1.0
 */
public class OrderController {

    private OrderService orderService = BeanFactory.newInstance(OrderService.class);

    @Test
    public void queryOrders(){
        List<Order> orders = orderService.queryOrders();
        orders.forEach(System.out::println);
    }
}

3.测试:

执行queryOrders()后控制台输出:

Order{id=1, userId=3, number='1000010', createtime=Wed Feb 04 13:22:35 CST 2015, note='质量很好'}
Order{id=2, userId=3, number='1000011', createtime=Tue Feb 03 13:22:41 CST 2015, note='非常漂亮'}
Order{id=3, userId=4, number='1000012', createtime=Thu Feb 12 16:13:23 CST 2015, note='物超所值'}

二.总结

1.手动映射的方式:

    <!--查询所有订单-->
    <select id="queryOrders" resultMap="orderResultMap">
        select * from `order`
    </select>
    <!--手动映射-->
    <resultMap id="orderResultMap" type="Order">
        <id column="id" property="id"/>
        <id column="user_id" property="userId"/>
        <id column="number" property="number"/>
        <id column="createtime" property="createtime"/>
        <id column="note" property="note"/>
    </resultMap>

这里还需要再说明一点的是，如果数据表字段仅有少数个同pojo对象属性名不一致的话，只需映射这几个不一致的字段即可！

上例可以简写为：

    <!--查询所有订单-->
    <select id="queryOrders" resultMap="orderResultMap">
        select * from `order`
    </select>
    <!--手动映射-->
    <resultMap id="orderResultMap" type="Order">
        <id column="user_id" property="userId"/>
    </resultMap>

2.log4j

①Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台

②在SqlMapConfig.xml中如何配置

    <!--配置log4j日志-->
    <settings>
        <setting name="logImpl" value="LOG4J"/>
    </settings>

③resources目录下需要添加配置文件log4j.properties(具体内容见案例中的代码展示)