MyBatis SQL语句构建器与SSM整合

作者: 拼搏男孩 | 来源:发表于2020-03-17 23:25 被阅读0次

一、MyBatis SQL语句构建器

有时候我们需要在Java代码中创建SQL语句，这时候我们就不得不面对加号、引号、换行、格式化问题、嵌入条件的逗号管理及 AND 连接等问题。对此，MyBatis 3 提供了方便的工具类来帮助解决此问题。借助 SQL 类，我们只需要简单地创建一个实例，并调用它的方法即可生成 SQL 语句。

SQLProvider.java

package com.qfedu.test;

import com.qfedu.pojo.User;
import org.apache.ibatis.jdbc.SQL;
import org.junit.Test;

public class SQLProvider {

    public String getAllUser(){
        return new SQL()
                .SELECT("uid")
                .SELECT("username", "password")
                .SELECT("age", "addr")
                .FROM("user")
//                .WHERE("uid = 1")
//                .OR()
//                .WHERE("username = 'zhangsan'")
                .toString();
    }

    /**
     * VALUES（column， values）方法，第一个参数为数据库的表里的列名，第二个参数为要填充的数据
     *  特别注意，要给每个value添加单引号，否则生成的sql语句中的值会被认为是sql表中的字段
     * @return
     */
    public String saveUser(){
        return new SQL()
                .INSERT_INTO("user")
                .VALUES("username", "'shixiaopeng'")
                .VALUES("password", "'999999'")
                .VALUES("age", "'20'")
                .VALUES("addr", "'北京'")
                .toString();
    }

    /**
     * VALUES（column， values）方法，第一个参数为数据库的表里的列名，第二个参数为要填充的数据
     *  特别注意：给每个value填充变量值的时候，可以使用#{value }的方式，
     *          其中value可以是对象的属性名，也可以是map中的key
     * @param u
     * @return
     */
    public String saveUsers(User u){
        return new SQL()
                .INSERT_INTO("user")
                .VALUES("username", "#{username}")
                .VALUES("password", "#{password}")
                .VALUES("age", "#{age}")
                .VALUES("addr", "#{addr}")
                .toString();
    }
}

这个类的主要作用是用来生成SQL语句。需要特别注意的是插入的时候如果直接填充字符串常量，字符串常量外面还要包括一对单引号，因为解析的时候会把外面的双引号去掉。而如果采用#{}就没有这个问题。

IUserDaoProvider.java

package com.qfedu.test;

import com.qfedu.pojo.User;
import org.apache.ibatis.annotations.InsertProvider;
import org.apache.ibatis.annotations.Options;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.SelectProvider;
import org.apache.ibatis.jdbc.SQL;

import java.util.List;

public interface IUserDaoProvider {

    /**
     *  type：类型为SQLProvider的构建器的类对象
     *  method：方法执行该类对象中的具体方法
     * @return
     */
    @SelectProvider(type = SQLProvider.class, method = "getAllUser")
    List<User> getAllUsers();

    /**
     *  type：类型为SQLProvider的构建器的类对象
     *  method：方法执行该类对象中的具体方法
     * @return
     */
    @InsertProvider(type = SQLProvider.class, method = "saveUser")
    int saveUser();

    /**
     *  type：类型为SQLProvider的构建器的类对象
     *  method：方法执行该类对象中的具体方法
     *  Options选项可以设置额外的参数：
     *         keyProperty主键属性，useGeneratedKeys是否使用生成策略
     * @return
     */
    @InsertProvider(type = SQLProvider.class, method = "saveUsers")
    @Options(useGeneratedKeys = true, keyProperty = "uid")
    int saveUsers(User u);
}

这个接口使用注解的方式实现MyBatis。最后一个保存用户的方法，添加了@Options注解，使用生成的键，并且指定主键是uid。

TestSQLProvider.java

package com.qfedu.test;

import com.qfedu.pojo.User;
import com.qfedu.util.SessionUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import java.util.List;

public class TestSQLProvider {

    private SqlSession session = null;

    @Before
    public void setUp() {

        session = SessionUtils.getSession();
    }

    @After
    public void tearDown() {
        SessionUtils.closeSession(session);
    }

    @Test
    public void testGetAllUsers() {
        IUserDaoProvider mapper = session.getMapper(IUserDaoProvider.class);

        List<User> list = mapper.getAllUsers();

        for (User u : list) {
            System.out.println(u);
        }
    }

    @Test
    public void testSaveUser(){

        IUserDaoProvider mapper = session.getMapper(IUserDaoProvider.class);

        int result = mapper.saveUser();

        System.out.println(result);
    }

    @Test
    public void testSaveUsers(){
        IUserDaoProvider mapper = session.getMapper(IUserDaoProvider.class);

        User u = new User();

        u.setUsername("litao");
        u.setPassword("000000");
        u.setAge(20);
        u.setAddr("wuhan");

        System.out.println(mapper.saveUsers(u));;
    }

    @Test
    public void testSQL(){
        SQLProvider sp = new SQLProvider();

        System.out.println(sp.getAllUser());
    }
}

二、SSM整合

SSM指的是Spring、Spring MVC与MyBatis，之前学习的都是各个部分单独怎么使用，现在要把这三个组件整合在一起。

1. 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.qianfeng</groupId>
    <artifactId>day70SSM</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>
    <properties>
        <!--统一管理spring相关产品的版本-->
        <spring-version>5.2.2.RELEASE</spring-version>
    </properties>
    <build>
        <plugins>
            <!-- define the project compile level -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.6.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>

            <!-- 添加tomcat插件 -->
            <plugin>
                <groupId>org.apache.tomcat.maven</groupId>
                <artifactId>tomcat7-maven-plugin</artifactId>
                <version>2.2</version>
                <configuration>
                    <path>/</path>
                    <port>8080</port>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.2</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>jstl</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.15</version>
        </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.10</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.4.6</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring-version}</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>com.springsource.org.aspectj.weaver</artifactId>
            <version>1.6.8.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>1.3.2</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.62</version>
        </dependency>

        <!--        <dependency>-->
<!--            <groupId>com.fasterxml.jackson.core</groupId>-->
<!--            <artifactId>jackson-databind</artifactId>-->
<!--            <version>2.10.2</version>-->
<!--        </dependency>-->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring-version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>${spring-version}</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.10</version>
        </dependency>

    </dependencies>
</project>

之前添加的依赖在整合的时候基本上都要添加，当然，如果不需要实现某项功能就不需要。唯一和之前不同的是这次对spring框架中的依赖进行了版本统一管理。另外，由于我使用jackson-databind会出现异常信息，所以就把这段依赖注释了，转而使用fastjson。使用fastjson需要在spring-mvc.xml中多配置一些东西，等会儿再说。

2. web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <servlet>
        <servlet-name>springDispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring-mvc.xml</param-value>
        </init-param>
    </servlet>
    <servlet-mapping>
        <servlet-name>springDispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
<!--    spring写好的中文过滤器-->
    <filter>
        <filter-name>encode</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>encode</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

web.xml中配置了两个东西，一个是转发控制器，另一个是spring的中文过滤器。

3. spring-mvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="suffix" value=".jsp"/>
    </bean>
    <context:component-scan base-package="com.qianfeng.controller"/>
    <context:component-scan base-package="com.qianfeng.service"/>
    <mvc:annotation-driven>
<!--        使用fastjson来替代默认的HttpMessageConverter以提高执行效率-->
        <mvc:message-converters>
            <bean class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter">
                <property name="supportedMediaTypes">
<!--                    设置UTF-8编码防止乱码-->
                    <list>
                        <value>application/json;charset=UTF-8</value>
                    </list>
                </property>

            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>
    <mvc:default-servlet-handler/>
    <import resource="classpath:spring-mybatis.xml"/>
</beans>

这个是springmvc的配置文件，配置了视图解析器，组件扫描，注解驱动，默认的servlet处理器，引入了资源文件。在注解驱动中我对fastjson进行了一些配置，主要用来防止中文乱码。这里配置的包扫描包括两个包：一个时controller，一个是service。

4. spring-mybatis.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
     xmlns:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop"
     xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd
    http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.3.xsd
    http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.3.xsd">

  <!-- 引入数据库配置信息文件 -->
  <context:property-placeholder location="classpath:db.properties" />

  <!-- 配置druid数据源 -->
  <bean id="ds" class="com.alibaba.druid.pool.DruidDataSource">
      <!--<property name="url" value="jdbc:mysql://localhost:3306/hello2"></property>-->
      <!--<property name="driverClassName" value="com.mysql.jdbc.Driver" />-->
      <!--<property name="username" value="root" />-->
      <!--<property name="password" value="123456" />-->
      <property name="url" value="${url}"></property>
      <property name="driverClassName" value="${driver}" />
      <property name="username" value="${user}" />
      <property name="password" value="${pass}" />
  </bean>

  <!-- 配置SqlSessionFactoryBean对象，用来获取SqlSession -->
  <!--
  我们知道在Mybatis的所有操作都是基于一个SqlSession的，而SqlSession是由SqlSessionFactory来产生的，
  SqlSessionFactory又是由SqlSessionFactoryBuilder来生成的。但是Mybatis-Spring是基于SqlSessionFactoryBean的。
  在使用Mybatis-Spring的时候，我们也需要SqlSession，而且这个SqlSession是内嵌在程序中的，一般不需要我们直接访问。
  SqlSession也是由SqlSessionFactory来产生的，但是Mybatis-Spring给我们封装了一个SqlSessionFactoryBean，
  在这个bean里面还是通过SqlSessionFactoryBuilder来建立对应的SqlSessionFactory，进而获取到对应的SqlSession。
  通过SqlSessionFactoryBean我们可以通过对其指定一些属性来提供Mybatis的一些配置信息。�
  -->
  <bean id="sf" class="org.mybatis.spring.SqlSessionFactoryBean">
      <property name="typeAliasesPackage" value="com.qfedu.pojo" />
      <property name="mapperLocations" value="classpath:com/qfedu/dao/mapper/*Mapper.xml" />
      <property name="dataSource" ref="ds"></property>
      <property name="configLocation" value="classpath:mybatis-config.xml" />
  </bean>

  <!-- 配置映射扫描器，分别设置dao包的扫描和SqlSessionFactory的指定 -->
  <!--
  Mybatis-Spring为我们提供了一个叫做MapperScannerConfigurer的类，
  通过这个类Mybatis-Spring会自动为我们注册Mapper对应的MapperFactoryBean对象。
  �如果我们需要使用MapperScannerConfigurer来帮我们自动扫描和注册Mapper接口的话我们需要在Spring的applicationContext配置文件中
  定义一个MapperScannerConfigurer对应的bean。对于MapperScannerConfigurer而言有一个属性是我们必须指定的，
  那就是basePackage。basePackage是用来指定Mapper接口文件所在的基包的，在这个基包或其所有子包下面的Mapper接口都将被搜索到。
  多个基包之间可以使用逗号或者分号进行分隔。最简单的MapperScannerConfigurer定义就是只指定一个basePackage属性。
  -->
  <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
      <property name="basePackage" value="com.qfedu.dao" />
      <property name="sqlSessionFactoryBeanName" value="sf" />
  </bean>

  <!-- 配置事务管理器 -->
  <bean id="dtx" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
      <property name="dataSource" ref="ds"></property>
  </bean>

  <tx:advice id="tx" transaction-manager="dtx">
      <!-- 声明属性，声明事务的规则 -->
      <tx:attributes>
          <tx:method name="save*" propagation="REQUIRED" isolation="DEFAULT" rollback-for="Exception" />
          <tx:method name="insert*" propagation="REQUIRED" isolation="DEFAULT" rollback-for="Exception" />
          <tx:method name="update*" propagation="REQUIRED" isolation="DEFAULT" rollback-for="Exception" />
          <tx:method name="delete*" propagation="REQUIRED" isolation="DEFAULT" rollback-for="Exception" />
      </tx:attributes>
  </tx:advice>

  <!-- 定义切面 -->
  <aop:config>
      <aop:pointcut id="mpt" expression="execution(* com.qfedu.service.*.*(..))" />
      <aop:advisor advice-ref="tx" pointcut-ref="mpt" />
  </aop:config>
</beans>

这个配置文件导入了db.properties文件，配置了DruidDataSource、SqlSessionFactoryBean、MapperScannerConfigurer、DataSourceTransactionManager、tx:advice、定义了切面

5. 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>
    <!--
        给当前mybatis项目添加日志功能，该STDOUT_LOGGING值的好处是不用添加第三方jar包就可以有日志的输出
    -->
    <settings>
        <setting name="logImpl" value="LOG4J"/>
    </settings>
</configuration>

尽管在上一个文件中几乎把所有的MyBatis配置都配置了，我们仍然有必要创建这个文件对mybatis进行一些私有化的配置。

6. log4j.properties

# 全局日志配置
log4j.rootLogger=ERROR, stdout, F
# MyBatis 日志配置
log4j.logger.com.qianfeng.dao.IUserDao=TRACE
# 控制台输出
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
# 文件输出
log4j.appender.F = org.apache.log4j.DailyRollingFileAppender
log4j.appender.F.File =myproj.log
log4j.appender.F.Append = true
log4j.appender.F.Threshold = DEBUG
log4j.appender.F.layout=org.apache.log4j.PatternLayout
log4j.appender.F.layout.ConversionPattern=%-d{yyyy-MM-dd HH\:mm\:ss}-[%p %F\:%L]  %m%n

这是log4j的配置文件

7. db.properties

driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3306/mydb
user=root
pass=123456

这是连接数据库时需要的配置信息，尽量不要使用user和password作为key。

8. IUserDao.java

package com.qianfeng.dao;

import com.qianfeng.pojo.User;
import org.apache.ibatis.annotations.Param;

import java.util.List;

public interface IUserDao {
    List<User> getAllUsers();
    int deleteUser(@Param("uid") int uid);
    User getUserById(@Param("uid") int uid);
    int updateUser(User user);
    int saveUser(User user);
}

我们使用了MyBatis配置的第二种方式：即使用接口+xml文件方式

9. IUserService与UserServiceImpl

package com.qianfeng.service;

import com.qianfeng.pojo.User;

import java.util.List;

public interface IUserService {
    List<User> getAllUsers();
    boolean deleteUser(int uid);
    User getUserById(int uid);
    boolean updateUser(User user);
    boolean saveUser(User user);
}

package com.qianfeng.service.impl;

import com.qianfeng.dao.IUserDao;
import com.qianfeng.pojo.User;
import com.qianfeng.service.IUserService;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import java.util.List;
@Service
public class UserServiceImpl implements IUserService {
    @Resource
    private IUserDao userDao;
    @Override
    public List<User> getAllUsers() {
        return userDao.getAllUsers();
    }

    @Override
    public boolean deleteUser(int uid) {
        return userDao.deleteUser(uid)>0;
    }

    @Override
    public User getUserById(int uid) {
        return userDao.getUserById(uid);
    }

    @Override
    public boolean updateUser(User user) {
        return userDao.updateUser(user)>0;
    }

    @Override
    public boolean saveUser(User user) {
        return userDao.saveUser(user)>0;
    }
}

使用service注解来配合组件扫描，使用Resouce注解不用使用new关键字来创建对象。

10. UserController.java

package com.qianfeng.controller;

import com.qianfeng.pojo.User;
import com.qianfeng.service.IUserService;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.servlet.ModelAndView;

import javax.annotation.Resource;
import java.util.List;

@Controller
public class UserController {
    @Resource
    private IUserService userService;
    @GetMapping("/users")
    public ModelAndView getAllUsers(){
        return new ModelAndView("/users","users",userService.getAllUsers());
    }
    @GetMapping("/deleteUser/{uid}")
    public String deleteUser(@PathVariable int uid){
        boolean flag = userService.deleteUser(uid);
        return "redirect:/users";
    }
    @GetMapping("/updateUser/{uid}")
    public ModelAndView updateUserPage(@PathVariable int uid){
        return new ModelAndView("/update","user",userService.getUserById(uid));
    }
    @PostMapping("/updateUser")
    public String updateUser(User user){
        boolean flag = userService.updateUser(user);
        return "redirect:/users";
    }
    @PostMapping("/saveUser")
    public String saveUser(User user){
        boolean flag = userService.saveUser(user);
        return "redirect:/users";
    }
}

这是一个controller，使用Controller注解来配合组件扫描

MyBatis SQL语句构建器与SSM整合

一、MyBatis SQL语句构建器

二、SSM整合

1. pom.xml

2. web.xml

3. spring-mvc.xml

4. spring-mybatis.xml

5. mybatis-config.xml

6. log4j.properties

7. db.properties

8. IUserDao.java

9. IUserService与UserServiceImpl

10. UserController.java

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读