Mybatis环境配置最终版

墨蓝 2023-10-01 17:37 14阅读 0赞

## 搭建环境 ##

> 也可根据官方文档来进行配置https://mybatis.org/mybatis-3/zh/index.html
> 
> 以下的内容配置均为经过实验的

### pom.xml配置 ###

<dependencies>
    
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>8.0.15</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.mybatis</groupId>
                <artifactId>mybatis</artifactId>
                <version>3.5.7</version>
            </dependency>
    
            
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.13.1</version>
                <scope>test</scope>
            </dependency>
            
            
            <dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.20</version>
                <scope>provided</scope>
            </dependency>
        </dependencies>
    
        
        <build>
            <resources>
                <resource>
                    <directory>src/main/resources</directory>
                    <includes>
                        <include>**/*.properties</include>
                        <include>**/*.xml</include>
                    </includes>
                </resource>
                <resource>
                    <directory>src/main/java</directory>
                    <includes>
                        <include>**/*.properties</include>
                        <include>**/*.xml</include>
                    </includes>
                    <filtering>true</filtering>
                </resource>
            </resources>
        </build>

### 编写xml核心配置文件 ###

> 在**resources包**下创建一个xml文件，**文件名为:mybatis-config.xml**
> 
> 修改配置文件中driver、url、username、password、resource的value
> 
> 如果报错，可以将开头的UTF-8改为UTF8或者删除xml中的注释

1.在resources文件夹下创建db.properties文件

driver=com.mysql.jdbc.Driver
    url=jdbc:mysql://localhost:3306/mybatis?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    username=root
    password=root
    #url=jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone = GMT

2.在xml文件中进行引用

<?xml version="1.0" encoding="UTF8" ?>
    <!DOCTYPE configuration
            PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
            "http://mybatis.org/dtd/mybatis-3-config.dtd">
    <configuration>
        
        <properties resource="db.properties"/>
        <settings>
    
            <setting name="cacheEnabled" value="true"/>
            <setting name="logImpl" value="LOG4J"/>
            <setting name="mapUnderscoreToCamelCase" value="true"/>
        </settings>
        <environments default="development">
            <environment id="development">
                <transactionManager type="JDBC"/>
                <dataSource type="POOLED">
                    <property name="driver" value="${driver}"/>
                    <property name="url" value="${url}"/>
    
                    <property name="username" value="${username}"/>
                    <property name="password" value="${password}"/>
                </dataSource>
            </environment>
        </environments>
        <mappers>
            
            <mapper resource="com/lzj/dao/UserMapper.xml"/>
        </mappers>
    </configuration>

3.在resources文件夹下创建log4j.properties文件

log4j.rootLogger=DEBUG,console,file
    log4j.additivity.org.apache=true
    # 控制台(console)
    log4j.appender.console=org.apache.log4j.ConsoleAppender
    log4j.appender.console.Threshold=DEBUG
    log4j.appender.console.ImmediateFlush=true
    log4j.appender.console.Target=System.out
    log4j.appender.console.layout=org.apache.log4j.PatternLayout
    log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    # 日志文件(logFile)
    log4j.appender.file=org.apache.log4j.RollingFileAppender
    log4j.appender.file.Threshold=DEBUG
    log4j.appender.file.MaxFileSize=10mb
    log4j.appender.file.Append=true
    log4j.appender.file.File=./log/lzj.log
    log4j.appender.file.layout=org.apache.log4j.PatternLayout
    log4j.appender.file.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
    #日志输出级别
    log4j.logger.org.mybatis=DEBUG
    log4j.logger.java.sql=DEBUG
    log4j.logger.java.sql.Statement=DEBUG
    log4j.logger.java.sql.ResultSet=DEBUG
    log4j.logger.java.sql.PreparedStatement=DEBUG

#### 类型别名优化（可选，加到mybatis-config.xml中） ####

*  类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置，意在降低冗余的全限定类名书写\*\*（实体类较少时建议这种方式，这种方式可以diy别名）\*\*
    
        
        <typeAliases>
                <typeAlias type="com.lzj.entity.User" alias="User"></typeAlias>
            </typeAliases>
 *  也可以指定一个包名，MyBatis 会在包名下面搜索需要的 Java Bean
    
        
        <typeAliases>
                <package name="com.lzj.entity"/>
            </typeAliases>
 *  每一个在包 `domain.blog` 中的 Java Bean，在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。 比如 `domain.blog.Author` 的别名为 `author`；若有注解，则别名为其注解值。
    
        @Alias("author")
        public class Author {
              
            ...
        }

### 编写Mybatis工具类 ###

//sqlSessionFactory --> sqlSession
    public class MybatisUtils {
        
        private  static SqlSessionFactory sqlSessionFactory;
        static {
        
            try {
        
                String resource = "mybatis-config.xml";
                InputStream inputStream = Resources.getResourceAsStream(resource);
                sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            } catch (IOException e) {
        
                e.printStackTrace();
            }
    
        }
        //既然有了 SqlSessionFactory，顾名思义，我们可以从中获得 SqlSession 的实例。
        // SqlSession 提供了在数据库执行 SQL 命令所需的所有方法
        public static SqlSession getSqlSession(){
        
    //        SqlSession sqlSession = sqlSessionFactory.openSession();
    //        return sqlSession;//下一行为优化后的结果
            return sqlSessionFactory.openSession();
        }
    
    }

### 编写实体类、Dao接口和接口实现类 ###

#### 实体类User ####

@Data
    @AllArgsConstructor
    public class User implements Serializable {
        
        private int id;
        private String name;
        private String pwd;
    }

#### Mapper接口 ####

public interface UserMapper {
        
        List<User> getUserList();
    }

#### 接口实现类 ####

> 由原来的UserDaoImpl转变为一个xml配置文件，文件名举例：UserMapper.xml
> 
> 如果报错，可以将开头的UTF-8改为UTF8或者删除xml中的注释
> 
> 配置文件名字要与接口名保持一致（例如：接口名为UserMapper，该文件名为UserMapper.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.lzj.dao.UserMapper">
    
    
        <select id="getUserList" resultType="com.lzj.entity.User">
            select * from mybatis.user
        </select>
    </mapper>

### 测试 ###

public class UserMapperTest {
        
        @Test
        public void test() {
        
            //获得SqlSession对象
            SqlSession sqlSession = MybatisUtils.getSqlSession();
            //方式一:通过getMapper执行SQL
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            List<User> userList = mapper.getUserList();
            for (User user : userList) {
        
                System.out.println(user);
            }
            
            //方式二:不推荐这种方式
            List<User> userList1 = sqlSession.selectList("com.lzj.dao.UserMapper.getUserList");
            for (User user : userList1) {
        
                System.out.println(user);
            }
            
            //关闭SqlSession对象
            sqlSession.close();
    
    
        }
    }

### 可能遇到的问题 ###

*  **maven资源无法导入xml的问题**
    
     *  在build中配置resources，来防止我们资源导出失败的问题
 *  **报错：1 字节的 UTF-8 序列的字节 1 无效**
 *  将xml中首行的的UTF-8改为UTF8
 *  将注释删除
 *  **数据库连接不上的问题**
    
     *  这个就需要自己排查mybatis-config.xml文件中的配置是否正确，url是否能够读取
 *  **映射器的问题**
    
     *  接口和他的Mapper配置文件必须同名
     *  接口和他的Mapper配置文件必须在同一个包下
 *  **如果数据库字段有\_则需要开启驼峰原则设置映射**
    
     *      <settings>
                <setting name="mapUnderscoreToCamelCase" value="true"/>
            </settings>