Учебники

iBATIS — динамический SQL

Январь 30, 2019

Динамический SQL — очень мощная функция iBATIS. Иногда вам нужно изменить критерий предложения WHERE в зависимости от состояния вашего объекта параметра. В таких ситуациях iBATIS предоставляет набор динамических тегов SQL, которые можно использовать в отображаемых операторах для повышения возможности повторного использования и гибкости SQL.

Вся логика помещена в файл .XML с использованием некоторых дополнительных тегов. Ниже приведен пример, в котором оператор SELECT будет работать двумя способами:

  • Если вы передадите идентификатор, он вернет все записи, соответствующие этому идентификатору.
  • В противном случае он вернет все записи, в которых идентификатор сотрудника имеет значение NULL. 
<?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>
..................

Если вам нужен запрос, в котором мы можем выбрать идентификатор и / или имя сотрудника, ваш оператор SELECT будет выглядеть следующим образом: 

..................
<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. Учтите, у нас есть следующая таблица EMPLOYEE в MySQL: 

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

Давайте предположим, что эта таблица имеет только одну запись следующим образом — 

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

Сотрудник POJO класса

Чтобы выполнить операцию чтения, давайте создадим класс Employee в Employee.java следующим образом: 

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

Чтобы определить оператор отображения SQL с помощью iBATIS, мы добавили бы следующий измененный тег <select> в Employee.xml, а внутри этого определения тега мы бы определили «id», который будет использоваться в IbatisReadDy.java для выполнения запроса Dynamic SQL SELECT в база данных. 

<?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 будет работать двумя способами:

  • Если вы передаете идентификатор, он возвращает записи, соответствующие этому идентификатору. В противном случае он возвращает все записи.

Если вы передаете идентификатор, он возвращает записи, соответствующие этому идентификатору. В противном случае он возвращает все записи.

Файл 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

Попробуйте приведенный выше пример, передав null как smc.queryForList («Employee.findByID», null) .

iBATIS OGNL Выражения

iBATIS предоставляет мощные выражения на основе OGNL для устранения большинства других элементов.

  • если заявление
  • выбрать, когда, в противном случае заявление
  • где заявление
  • оператор 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>

Этот оператор предоставляет необязательный тип текстового поиска. Если вы не укажете название, все активные блоги будут возвращены. Но если вы передадите заголовок, он будет искать заголовок с заданным аналогичным условием.

Вы можете включить несколько, если следующие условия — 

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

Выбор, когда и в противном случае Заявления

iBATIS предлагает элемент выбора, который похож на оператор переключения Java. Это помогает выбрать только один случай среди множества вариантов.

В следующем примере поиск будет выполняться только по заголовку, если он указан, и только по автору, если он указан. Если ни один из них не предоставлен, он возвращает только избранные блоги — 

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

Где заявление

Взгляните на наши предыдущие примеры, чтобы увидеть, что произойдет, если не будет выполнено ни одно из условий. В итоге вы получите 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, только когда содержащие теги возвращают какой-либо контент. Кроме того, если этот контент начинается с И или ИЛИ, он знает, как удалить его.

Заявление foreach

Элемент foreach позволяет указать коллекцию и объявить переменные элемента и индекса, которые можно использовать внутри тела элемента.

Это также позволяет вам указывать открывающую и закрывающую строки и добавлять разделитель для размещения между итерациями. Вы можете построить условие IN следующим образом:

55
Share: