MyBatis知多少（25）動態SQL

時間 2019-11-06

標籤 mybatis 多少動態 sql 欄目 MyBatis 简体版

原文原文鏈接

使用動態查詢是MyBatis一個很是強大的功能。有時你已經改變WHERE子句條件的基礎上你的參數對象的狀態。在這種狀況下的MyBatis提供了一組能夠映射語句中使用，以提升SQL語句的重用性和靈活性的動態SQL標籤。html

全部的邏輯是使用一些額外的標籤放在：XML文件。下面是一個例子，其中的SELECT語句將努力在兩個方面：java

若是想傳遞一個ID，而後它會返回全部與該ID的記錄，mysql
不然，將返回全部僱員ID爲NULL的記錄。sql

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sqlMap 
PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN"
"http://ibatis.apache.org/dtd/sql-map-2.dtd">

<sqlMap namespace="Employee">
<select id="findByID" resultClass="Employee">
   SELECT * FROM EMPLOYEE
   <dynamic prepend="WHERE ">
      <isNull property="id">
         id IS NULL
      </isNull>
      <isNotNull property="id">
         id = #id#
      </isNotNull>
   </dynamic>
</select>
</sqlMap>

可使用<isNotEmpty>標籤以下檢查條件。在此條件下將增長，只有當經過屬性不爲空。數據庫

..................
<select id="findByID" resultClass="Employee">
   SELECT * FROM EMPLOYEE
   <dynamic prepend="WHERE ">
      <isNotEmpty property="id">
           id = #id#
      </isNotEmpty>
   </dynamic>
</select>
..................

若是想查詢對id和/或僱員的名字選取。SELECT語句以下：apache

..................
<select id="findByID" resultClass="Employee">
   SELECT * FROM EMPLOYEE
   <dynamic prepend="WHERE ">
      <isNotEmpty prepend="AND" property="id">
           id = #id#
      </isNotEmpty>
      <isNotEmpty prepend="OR" property="first_name">
           first_name = #first_name#
      </isNotEmpty>
   </dynamic>
</select>
..................

例如：動態SQL

下面的例子將展現如何編寫SELECT語句中使用動態SQL。考慮，咱們已經在MySQL下有EMPLOYEE表：dom

CREATE TABLE EMPLOYEE (
   id INT NOT NULL auto_increment,
   first_name VARCHAR(20) default NULL,
   last_name  VARCHAR(20) default NULL,
   salary     INT  default NULL,
   PRIMARY KEY (id)
);

此表有以下只有一條記錄：ui

mysql> select * from EMPLOYEE;
+----+------------+-----------+--------+
| id | first_name | last_name | salary |
+----+------------+-----------+--------+
|  1 | Zara       | Ali       |   5000 |
|  2 | Roma       | Ali       |   3000 |
|  3 | Noha       | Ali       |   7000 |
+----+------------+-----------+--------+
3 row in set (0.00 sec)

Employee POJO 類:

要執行讀取操做，讓咱們在Employee.java文件Employee類，以下所示：this

public class Employee {
  private int id;
  private String first_name; 
  private String last_name;   
  private int salary;  

  /* Define constructors for the Employee class. */
  public Employee() {}
  
  public Employee(String fname, String lname, int salary) {
    this.first_name = fname;
    this.last_name = lname;
    this.salary = salary;
  }

  /* Here are the method definitions */
  public int getId() {
    return id;
  }
  public String getFirstName() {
    return first_name;
  }
  public String getLastName() {
    return last_name;
  }
  public int getSalary() {
    return salary;
  }
} /* End of Employee */

Employee.xml 文件:

要定義使用iBATIS SQL映射語句，咱們將增長在如下文件Employee.xml修改<select>標記和這個標籤訂義，咱們將定義一個「id」，這將被用於IbatisReadDy.java文件上執行動態SQL的SELECT查詢數據庫。spa

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sqlMap 
PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN"
"http://ibatis.apache.org/dtd/sql-map-2.dtd">

<sqlMap namespace="Employee">
<select id="findByID" resultClass="Employee">
   SELECT * FROM EMPLOYEE
   <dynamic prepend="WHERE ">
      <isNotNull property="id">
         id = #id#
      </isNotNull>
   </dynamic>
</select>
</sqlMap>

上面的SELECT語句將努力在兩個方面（一）若是想傳遞一個ID，而後將相應的編號（二）返回的記錄，不然將返回全部記錄。

IbatisReadDy.java 文件:

文件將應用程序級別的邏輯從Employee表讀出的條件記錄：

import com.ibatis.common.resources.Resources;
import com.ibatis.sqlmap.client.SqlMapClient;
import com.ibatis.sqlmap.client.SqlMapClientBuilder;
import java.io.*;
import java.sql.SQLException;
import java.util.*;

public class IbatisReadDy{
  public static void main(String[] args)
   throws IOException,SQLException{
   Reader rd=Resources.getResourceAsReader("SqlMapConfig.xml");
   SqlMapClient smc=SqlMapClientBuilder.buildSqlMapClient(rd);

   /* This would read all records from the Employee table.*/
   System.out.println("Going to read records.....");
   Employee rec = new Employee();
   rec.setId(1);

   List <Employee> ems = (List<Employee>)
                   smc.queryForList("Employee.findByID", rec);
   Employee em = null;
   for (Employee e : ems) {
      System.out.print("  " + e.getId());
      System.out.print("  " + e.getFirstName());
      System.out.print("  " + e.getLastName());
      System.out.print("  " + e.getSalary());
      em = e; 
      System.out.println("");
   }    

   System.out.println("Records Read Successfully ");

  }
}

編譯和運行：

下面是步驟來編譯並運行上述應用。請確保已在進行的編譯和執行以前，適當地設置PATH和CLASSPATH。

建立Employee.xml如上所示。
建立Employee.java如上圖所示，並編譯它。
建立IbatisReadDy.java如上圖所示，並編譯它。
執行IbatisReadDy二進制文件來運行程序。

會獲得下面的結果，而且將記錄從EMPLOYEE表中讀取。

Going to read records.....
  1  Zara  Ali  5000
Record Reads Successfully

試試上面的例子中經過傳遞空值做爲smc.queryForList（「Employee.findByID」，NULL）。

iBATIS OGNL 表達式

iBATIS的提供了強大的基於OGNL的表達式來消除其餘元素。

if 語句
choose, when, otherwise 語句
where 語句
foreach 語句

if語句：

最多見的事情在動態SQL是有條件地包括一個where子句的一部分。例如：

<select id="findActiveBlogWithTitleLike"
           parameterType="Blog" resultType="Blog">
   SELECT * FROM BLOG
   WHERE state = 'ACTIVE.
   <if test="title != null">
      AND title like #{title}
   </if>
</select>

這條語句會提供功能的可選的文本搜索類型。若是沒有傳遞title，那麼全部激活的博客將被退回。可是，若是傳遞一個標題，它會尋找標題以like 給定的條件。

能夠包括多個if條件以下：

最多見的事情在動態SQL是有條件地包括一個where子句的一部分。例如：

<select id="findActiveBlogWithTitleLike"
           parameterType="Blog" resultType="Blog">
   SELECT * FROM BLOG
   WHERE state = 'ACTIVE.
   <if test="title != null">
      AND title like #{title}
   </if>
   <if test="author != null">
      AND author like #{author}
   </if>
</select>

choose, when, otherwise 語句:

iBATIS提供了一個選擇的元素，它相似於Java的switch語句。這有助於選擇不少種狀況。

下面的例子將只搜索標題上若是提供，那麼只有由做者若是已提供。若是沒有提供，讓咱們只返回精選的博客：

<select id="findActiveBlogWithTitleLike"
           parameterType="Blog" resultType="Blog">
   SELECT * FROM BLOG
   WHERE state = 'ACTIVE.
   <choose>
      <when test="title != null">
         AND title like #{title}
      </when>
      <when test="author != null and author.name != null">
         AND author like #{author}
      </when>
      <otherwise>
         AND featured = 1
      </otherwise>
   </choose>
</select>

where 語句:

若是咱們看一下前面的例子中，若是沒有一個條件知足會發生什麼事？最終SQL看起來像這樣：

SELECT * FROM BLOG
WHERE

這會失敗，但iBATIS有一個簡單的改變一個簡單的解決方案，讓一切工做正常：

 <select id="findActiveBlogLike"
           parameterType="Blog" resultType="Blog">
   SELECT * FROM BLOG
   <where>
      <if test="state != null">
         state = #{state}
      </if>
      <if test="title != null">
         AND title like #{title}
      </if>
      <if test="author != null>
         AND author like #{author}
      </if>
   </where>
</select>

where元素知道只有插入WHERE ，若是有一個由含標籤返回的任何內容。此外，若是該內容開頭AND或OR，它知道剝離其關閉。

foreach語句：

foreach元素是很是強大的，並容許你指定一個集合，聲明能夠在元素的體內可用於項目和索引變量。

它也容許你指定打開和關閉的字符串，並添加一個分隔符放置在迭代之間。能夠創建一個IN條件以下：

<select id="selectPostIn" resultType="domain.blog.Post">
   SELECT *
   FROM POST P
   WHERE ID in
   <foreach item="item" index="index" collection="list"
      open="(" separator="," close=")">
         #{item}
   </foreach>
</select>