MyBatis笔记(1):入门程序/狂神说

x33g5p2x  于2022-02-11 转载在 其他  
字(17.0k)|赞(0)|评价(0)|浏览(217)

0、写在前面

1、什么是MyBatis

2、MyBatis第一个程序

0、写在前面

环境说明:

  • jdk 8 +
  • MySQL 5.7.19
  • maven-3.6.1
  • IDEA

学习前需要掌握:

  • JDBC
  • MySQL
  • Java 基础
  • Maven
  • Junit

1、什么是MyBatis

  • MyBatis 是一款优秀的持久层框架
  • MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集的过程
  • MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息,将接口和 Java 的 实体类 【Plain Old Java Objects,普通的 Java对象】映射成数据库中的记录。
  • MyBatis 本是apache的一个开源项目ibatis, 2010年这个项目由apache 迁移到了google code,并且改名为MyBatis 。
  • 2013年11月迁移到Github .
  • Mybatis官方文档 : http://www.mybatis.org/mybatis-3/zh/index.html
  • GitHub : https://github.com/mybatis/mybatis-3
    持久化

持久化是将程序数据在持久状态和瞬时状态间转换的机制。

  • 即把数据(如内存中的对象)保存到可永久保存的存储设备中(如磁盘)。
  • 持久化的主要应用是将内存中的对象存储在数据库中,或者存储在磁盘文件中、XML数据文件中等等。
  • JDBC就是一种持久化机制。
  • 文件IO也是一种持久化机制。
  • 在生活中 : 将鲜肉冷藏,吃的时候再解冻的方法也是。将水果做成罐头的方法也是。

为什么需要持久化服务呢?那是由于内存本身的缺陷引起的

  • 内存断电后数据会丢失,但有一些对象是无论如何都不能丢失的,比如银行账号等,遗憾的是,人们还无法保证内存永不掉电。
  • 内存过于昂贵,与硬盘、光盘等外存相比,内存的价格要高2~3个数量级,而且维持成本也高,至少需要一直供电吧。所以即使对象不需要永久保存,也会因为内存的容量限制不能一直呆在内存中,需要持久化来缓存到外存。
    持久层

什么是持久层?

  • 完成持久化工作的代码块 .  ---->  dao层 【DAO (Data Access Object)  数据访问对象】

  • 大多数情况下特别是企业级应用,数据持久化往往也就意味着将内存中的数据保存到磁盘上加以固化,而持久化的实现过程则大多通过各种关系数据库来完成。

  • 不过这里有一个字需要特别强调,也就是所谓的“层”。对于应用系统而言,数据持久功能大多是必不可少的组成部分。也就是说,我们的系统中,已经天然的具备了“持久层”概念?也许是,但也许实际情况并非如此。之所以要独立出一个“持久层”的概念,而不是“持久模块”,“持久单元”,也就意味着,我们的系统架构中,应该有一个相对独立的逻辑层面,专注于数据持久化逻辑的实现.

  • 与系统其他部分相对而言,这个层面应该具有一个较为清晰和严格的逻辑边界。【说白了就是用来操作数据库存在的!】
    为什么需要Mybatis

  • Mybatis就是帮助程序猿将数据存入数据库中 , 和从数据库中取数据 .

  • 传统的jdbc操作 , 有很多重复代码块 .比如 : 数据取出时的封装 , 数据库的建立连接等等... , 通过框架可以减少重复代码,提高开发效率 .

  • MyBatis 是一个半自动化的ORM框架 (Object Relationship Mapping) -->对象关系映射

  • 所有的事情,不用Mybatis依旧可以做到,只是用了它,所有实现会更加简单!技术没有高低之分,只有使用这个技术的人有高低之别

  • MyBatis的优点

  • 简单易学:本身就很小且简单。没有任何第三方依赖,最简单安装只要两个jar文件+配置几个sql映射文件就可以了,易于学习,易于使用,通过文档和源代码,可以比较完全的掌握它的设计思路和实现。

  • 灵活:mybatis不会对应用程序或者数据库的现有设计强加任何影响。sql写在xml里,便于统一管理和优化。通过sql语句可以满足操作数据库的所有需求。

  • 解除sql与程序代码的耦合:通过提供DAO层,将业务逻辑和数据访问逻辑分离,使系统的设计更清晰,更易维护,更易单元测试。sql和代码的分离,提高了可维护性。

  • 提供xml标签,支持编写动态sql。

  • .......

  • 最重要的一点,使用的人多!公司需要!

2、MyBatis第一个程序

入门文档:mybatis – MyBatis 3 | 入门

思路流程:搭建环境-->导入Mybatis--->编写代码--->测试

新建项目:

  • 新建一个普通maven项目MybatisCrane

  • 删除src

  • 创建模块mybatis-01

  • 编写mybatis的核心配置文件  mybatis-config.xml

  • 编写mybatis工具类 MybatisUtils

  • 编写代码

  • 实体类

  • Dao接口

  • 接口实现类

  • 测试

其中:父pom

<?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.crane</groupId>
    <artifactId>MybatisCrane</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>mybatis-01</module>
    </modules>
    <!-- 导入依赖 -->
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.2</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>dom4j</groupId>
            <artifactId>dom4j</artifactId>
            <version>1.6.1</version>
        </dependency>
        <dependency>
            <groupId>jaxen</groupId>
            <artifactId>jaxen</artifactId>
            <version>1.1.6</version>
        </dependency>
    </dependencies>

</project>

mybatis-config.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核心配置文件  -->
<configuration>
    <!-- 配置properties
         可以在标签内部配置连接数据库的信息,也可以通过属性引用外部配置文件的信息
         resource属性:常用的
               用于指定配置文件的位置,是按照类路径的写法来写,并且必须存在于类路径下。
        url属性:
               是要求按照url的协发来写地址
               url:统一资源定位符,他是唯一表示一个资源的位置
               写法:
                   http://localhost:8080/mybatisserver/demo1Servlet
                   协议       主机     端口     uri
              uri:统一资源标识符。他是应用中可以唯一定位一个资源的
    -->
    <properties resource="db.properties"></properties>

    <!-- 使用typeAlias用于配置别名。它只能配置domain类中的别名 -->
    <typeAliases>
        <!-- typeAlias用于配置别名。type属性指定的是实体类权限定类名。alias属性指定别名。当制定了别名就不再区分大小写-->
<!--        <typeAlias type="com.crane.domain.User" alias="user"></typeAlias>-->
        <!-- 用于指定要配置别名的包,当指定之后,该包下的实体类都会注册别名。并类名就是别名,不再区分大小写-->
        <package name="com.crane.domain"></package>
    </typeAliases>
    <!-- 配置环境  -->
    <environments default="mysql">
        <!-- 配置development的环境  -->
        <environment id="mysql">
            <!-- 配置事务类型 -->
            <transactionManager type="JDBC" />
            <!-- 配置数据源(连接池) -->
            <dataSource type="POOLED">
                <!-- 配置连接数据库的4个基本信息  -->
                <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>

    <!-- 指定映射配置文件的位置,映射配置文件指每个dao独立的配置文件
         xml方式: <mapper resource="com/crane/dao/IUserDao.xml"></mapper>
         注解方式: <mapper class="com.crane.dao.IUserDao"></mapper>
         如果使用注解来配置的话,此处应该使用class属性指定被注解的dao权限定类名
    -->
    <mappers>
<!--        <mapper resource="com/crane/dao/IUserDao.xml"></mapper>-->
        <!-- package标签是用于指定dao接口所在的包,当指定之后就不需要写mapper以及resource或者class了-->
        <package name="com.crane.dao.IUserDao"/>
    </mappers>
</configuration>

db.properties

jdbc.driver=com.mysql.jdbc.Driver
#jdbc.url=jdbc:mysql://localhost:3306/mybatis
jdbc.url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=UTF-8"
jdbc.username=root
jdbc.password=123456

工具类:获取sqlSession

//sqlSessionFactory --> sqlSession
public class MybatisUtils {

    private static SqlSessionFactory sqlSessionFactory;
    static{
        try {
            //使用Mybatis第一步:获取sqlSessionFactory对象
            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(){
        return sqlSessionFactory.openSession();
    }

}

实体类User:

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    private int id;
    private String name;
    private String pwd;
}
  • Dao接口
/**
 * 基于xml文件
 *
 * @Description  用户的持久层接口
 **/
public interface UserDao {

    /**
     * @Description : 查询所有操作
     **/
    @Select("select * from user")
    List<User> findAll();

    /**
     * @Description : 查询所有操作
     **/
    @Select("select id from mybatis.merchant_wallet_info where id > 0 and gondar_list_type = '97' limit 5")
    List<Integer> findAllIds();

    /**
     * @Description  保存所有用户
     **/
    @Insert("insert into user(username,address,sex,birthday)values(#{username},#{address},#{sex},#{birthday})")
    int saveUser(User user);

    @Insert("INSERT INTO user(username,address,sex,birthday) " +
            "VALUES(#{username},#{address},#{sex},#{birthday})")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    int insertUser(User user);

    /**
     * @Description  更新用户
     **/
    @Update("update user set username=#{username},address=#{address},sex=#{sex},birthday=#{birthday}" +
            "where id = #{id}")
    int updateUser(User user);

    /**
     * @Description  删除用户
     **/
    @Delete("delete from user where id=#{userId}")
    int deleteUser(Integer userId);
    /**
     * @Description  根据id查询
     **/
    @Select("select username,address,sex,birthday from user where id=#{id}")
    User findById(Integer userId);

    /**
     * @Description  根据username模糊查询
     **/        
    List<User> findByName(String username);

    /**
     * @Description  查询总用户数--聚合
     **/
    int findTotal();

    /**
     * @Description  根据queryVo中的查询条件查询对象
     **/
    List<User> findUserByVo(QueryVo vo);

    /**
     * @Description 根据条件查询
     * @Param 查询条件可能有用户名,明别,也可能有地址,或者都有
     * @return
     **/
    List<User> findUserByCondition(User user);

接口实现类:由原来的UserDaoImpl转变成一个Mapper配置文件

IUserDao.xml

其中:namespace相当于实现了Dao接口

<?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">
<!-- namespace绑定一个对应的Dao/Mapper接口:例如UserDao -->
<mapper namespace="com.crane.dao.UserDao">
    <!-- 配置查询所有 -->
    <!-- id: 对应方法名称
         resultType:用于将查询结果封装到User中并放到List中,写全限定名。
         如果没有该属性,spring能封装表和对象,但不知道查询结果封装到哪个对象。
    -->
    <select id="findAll" resultType="com.crane.domain.User">
        select * from user
    </select>

    <!--  保存用户 -->
    <insert id="saveUser" parameterType="com.crane.domain.User">
        insert into user(username,address,sex,birthday) values(#{username},#{address},#{sex},#{birthday})
    </insert>

    <!--  更新用户 -->
    <update id="updateUser" parameterType="com.crane.domain.User">
        update user set username=#{username},address=#{address},sex=#{sex},birthday=#{birthday} where id=#{id}
    </update>

    <!--  删除用户 ,此时的uid表示占位符,不用和方法参数一样。uid/id/userId等都可以-->
    <delete id="deleteUser" parameterType="java.lang.Integer">
        delete from user where id=#{uid}
    </delete>

    <!--  根据id查询用户 ,此时的uid表示占位符,不用和方法参数一样。uid/id/userId等都可以-->
    <select id="findById" parameterType="java.lang.Integer" resultType="com.crane.domain.User">
        select * from user where id=#{uid}
    </select>

    <!--  根据名称模糊查询用户 ,此时的uid表示占位符,不用和方法参数一样。uid/id/userId等都可以-->
    <select id="findByName" parameterType="java.lang.String" resultType="com.crane.domain.User">
         select * from user where username like #{username}
    <!--  select * from user where username like '%${value}%' -->
 </select>

 <!--   获取用户总记录数 ,此时的uid表示占位符,不用和方法参数一样。uid/id/userId等都可以-->
    <select id="findTotal"  resultType="int">
        select count(id) from user
    </select>

    <!-- 根据queryVo中查询条件查询用户  -->
    <select id="findUserByVo" parameterType="com.crane.domain.QueryVo" resultType="com.crane.domain.User">
        select * from user where username like #{user.username}
    </select>

    <!-- 根据查询条件   -->
    <select id="findUserByCondition" resultType="com.crane.domain.User" parameterType="com.crane.domain.User">
        select * from user where 1=1
        <if test="username != null and username != '' ">
            and username = #{username}
        </if>

    </select>

</mapper>

测试

public class UserDaoTest {

    @Test
    public void test(){
        //第一步:获取sqlSession对象
        SqlSession sqlSession = MybatisUtils.getSqlSession();

        //方式1:执行SQL
        UserDao userDao = sqlSession.getMapper(UserDao.class);
        List<User> all = userDao.findAll();

        //方式2:不推荐使用
        List<User> userList = sqlSession.selectList("com.crane.dao.UserDao.findAll");
        for (User user:all){
            System.out.println(user);
        }
        //关闭sqlSession
        sqlSession.close();
    }
}

可能遇到的问题

  • 1、配置文件没有注册
  • 2、绑定接口错误
  • 3、方法名不对称性
  • 4、返回类型不对
  • 5、Maven导出资源问题

问题1:

org.apache.ibatis.binding.BindingException: Type interface com.crane.dao.UserDao is not known to the MapperRegistry.
原因是需要在mybatis-config.xml中添加.   </mapper>

<?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核心配置文件  -->
<configuration>

    <properties resource="db.properties"></properties>

    
    <package name="com.crane.domain"></package>
    </typeAliases>
  
    <environments default="mysql">
        <!-- 配置development的环境  -->
        <environment id="mysql">
            <!-- 配置事务类型 -->
            <transactionManager type="JDBC" />
            <!-- 配置数据源(连接池) -->
            <dataSource type="POOLED">
                <!-- 配置连接数据库的4个基本信息  -->
                <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.xml都需要在Mybatis核心配置文件中注册 -->
    <mappers>
        <mapper resource="com/crane/dao/UserMapper.xml"></mapper>
    </mappers>
</configuration>

问题2:  Maven问题(配置文件问题)

java.lang.ExceptionInInitializerError Caused by: java.io.IOException: Could not find resource com/crane/dao/UserMapper.xml

原因:正常配置文件是放到 src/main/resouces 目录下,现在我们将UserMapper.xml放到了 src/main/java目录下,是不能导出的,需要我们手动配置让其导出到target/classes下

方案:Maven由于约定大约配置,我们可能会遇到我们写的配置文件,无法被导出或者生效的问题,解决方案:

在父pom和子pom中添加如下:

<!-- 在build 中配置resources, 来防止我们资源导出失败的问题-->
    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

注意:所有的maven项目首先都要先配置上上述地<build>

重要:转:Maven <resource>标签 - 神一样的存在 - 博客园

maven之<build> <resources> <resource> 详细介绍_涂作权的博客-CSDN博客_build resources

1、搭建实验数据库

CREATE DATABASE `mybatis`;

USE `mybatis`;

DROP TABLE IF EXISTS `user`;

CREATE TABLE `user` (
`id` int(20) NOT NULL,
`name` varchar(30) DEFAULT NULL,
`pwd` varchar(30) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

insert  into `user`(`id`,`name`,`pwd`) values (1,'狂神','123456'),(2,'张三','abcdef'),(3,'李四','987654');

2、导入MyBatis相关 jar 包

  • GitHub上找
<dependency>
   <groupId>org.mybatis</groupId>
   <artifactId>mybatis</artifactId>
   <version>3.5.2</version>
</dependency>
<dependency>
   <groupId>mysql</groupId>
   <artifactId>mysql-connector-java</artifactId>
   <version>5.1.47</version>
</dependency>

3、编写MyBatis核心配置文件

<?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>
   <environments default="development">
       <environment id="development">
           <transactionManager type="JDBC"/>
           <dataSource type="POOLED">
               <property name="driver" value="com.mysql.jdbc.Driver"/>
               <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&amp;useUnicode=true&amp;characterEncoding=utf8"/>
               <property name="username" value="root"/>
               <property name="password" value="123456"/>
           </dataSource>
       </environment>
   </environments>
   <mappers>
       <mapper resource="com/kuang/dao/userMapper.xml"/>
   </mappers>
</configuration>

4、编写MyBatis工具类

import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import java.io.IOException;
import java.io.InputStream;

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();
      }
  }

   //获取SqlSession连接
   public static SqlSession getSession(){
       return sqlSessionFactory.openSession();
  }

}

5、创建实体类

public class User {
   
   private int id;  //id
   private String name;   //姓名
   private String pwd;   //密码
   
   //构造,有参,无参
   //set/get
   //toString()
   
}

6、编写Mapper接口类

import com.kuang.pojo.User;
import java.util.List;

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

7、编写Mapper.xml配置文件

  • namespace 十分重要,不能写错!
<?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.kuang.dao.UserMapper">
 <select id="selectUser" resultType="com.kuang.pojo.User">
  select * from user
 </select>
</mapper>

8、编写测试类

  • Junit 包测试
public class MyTest {
   @Test
   public void selectUser() {
       SqlSession session = MybatisUtils.getSession();
       //方法一:
       //List<User> users = session.selectList("com.kuang.mapper.UserMapper.selectUser");
       //方法二:
       UserMapper mapper = session.getMapper(UserMapper.class);
       List<User> users = mapper.selectUser();

       for (User user: users){
           System.out.println(user);
      }
       session.close();
  }
}

9、运行测试,成功的查询出来的我们的数据,ok!

问题说明

可能出现问题说明:Maven静态资源过滤问

<resources>
   <resource>
       <directory>src/main/java</directory>
       <includes>
           <include>**/*.properties</include>
           <include>**/*.xml</include>
       </includes>
       <filtering>false</filtering>
   </resource>
   <resource>
       <directory>src/main/resources</directory>
       <includes>
           <include>**/*.properties</include>
           <include>**/*.xml</include>
       </includes>
       <filtering>false</filtering>
   </resource>
</resources>

相关文章