2. 程式人生 > >Mybatis呼叫PostgreSQL儲存過程實現陣列入參傳遞

Mybatis呼叫PostgreSQL儲存過程實現陣列入參傳遞

阿新 • • 發佈：2019-01-24

前言

專案中用到了Mybatis呼叫PostgreSQL儲存過程（自定義函式）相關操作，由於PostgreSQL自帶陣列型別，所以有一個自定義函式的入參就是一個int陣列，形如：

CREATE OR REPLACE FUNCTION "public"."func_arr_update"(ids _int4)...

如上所示，引數是一個int陣列，Mybatis提供了對呼叫儲存過程的支援，那麼PostgreSQL獨有的陣列型別作為儲存過程的引數又將如何處理呢？其實很簡單，mybatis提供了typeHandlers可以建立一個數組型別的型別處理器，具體做法為：實現 org.apache.ibatis.type.TypeHandler

介面， 或繼承一個很便利的類 org.apache.ibatis.type.BaseTypeHandler， 然後可以選擇性地將它對映到一個 JDBC 型別，先稍作了解，後面再做詳細說明，接下來依舊結合一個示例來看看。

建立自定義函式

如圖，第一步首先是建立一個用於呼叫的自定義函式，功能也很簡單，遍歷引數陣列的每一個元素和t_student表的stuid做比較，若一致，則修改那條記錄的stuname（在其後拼接一段字串），該自定義函式的DLL語句如下：

CREATE OR REPLACE FUNCTION "public"."func_arr_update"(ids _int4)
  RETURNS "pg_catalog"
 
."void" AS $BODY$
DECLARE
     scount INTEGER;
     rownum integer := 1;
BEGIN
        scount:=array_length(ids,1);
        while rownum <= scount LOOP
            update t_student set stuname = stuname || ' has been modified. ' where stuid = ids[rownum];
            rownum := rownum + 1;
    END
 
 LOOP;
    RETURN;
END
$BODY$
  LANGUAGE 'plpgsql' VOLATILE COST 100
;

ALTER FUNCTION "public"."func_arr_update"(ids _int4) OWNER TO "postgres";

很簡單，獲取到引數陣列的長度後開始迴圈，匹配stuid並更新stuname，直接在資料庫呼叫一下看看結果：
這裡寫圖片描述
這裡寫圖片描述

如上圖，可以看到成功修改了stuid為101，102和103的stuname，自定義函式已經沒問題了，接下來就具體看一下如何通過mybatis呼叫。

呼叫自定義函式

mybatis中呼叫自定義函式很簡單，Mapper XML檔案中的select元素直接提供了屬性支援——statementType，在官方文件中可以看到：
這裡寫圖片描述
這裡寫圖片描述

如上圖，statementType的值預設是PREPARED，也就是說底層預設會使用jdbc的PreparedStatement，而我們都知道jdbc呼叫儲存過程時需要用CallableStatement，所以在這裡我們需要將statementType的值設定為CALLABLE。

mybatis預設的ArrayTypeHandler

呼叫儲存過程很簡單，那麼接下來的問題是如何在mybatis中傳一個數組引數到儲存過程中呢？這裡就要用到另外一個概念——TypeHandler，這是mybatis提供的自定義型別轉換器，mybatis在預編譯語句物件（PreparedStatement）設定引數時或是從結果集中取值時都會用型別處理器將獲取的值以合適的方式轉換成Java型別，mybatis預設實現了一部分TypeHandler供我們使用，當我們沒有指定TypeHandler時（大多數情況都不會指定），mybatis會根據引數或者返回結果的不同，預設為我們選擇合適的TypeHandler處理，下面可以通過檢視原始碼大概看一下預設的TypeHandler，匯入原始碼後可以在org.apache.ibatis.type包下找到一個TypeHandlerRegistry類，typeHandler正是通過這個類管理的，先看一下它的構造方法：

 public TypeHandlerRegistry() {
    register(Boolean.class, new BooleanTypeHandler());
    register(boolean.class, new BooleanTypeHandler());
    register(JdbcType.BOOLEAN, new BooleanTypeHandler());
    register(JdbcType.BIT, new BooleanTypeHandler());

    register(Byte.class, new ByteTypeHandler());
    register(byte.class, new ByteTypeHandler());
    register(JdbcType.TINYINT, new ByteTypeHandler());

    register(Short.class, new ShortTypeHandler());
    register(short.class, new ShortTypeHandler());
    register(JdbcType.SMALLINT, new ShortTypeHandler());

    register(Integer.class, new IntegerTypeHandler());
    register(int.class, new IntegerTypeHandler());
    register(JdbcType.INTEGER, new IntegerTypeHandler());

    register(Long.class, new LongTypeHandler());
    register(long.class, new LongTypeHandler());

    register(Float.class, new FloatTypeHandler());
    register(float.class, new FloatTypeHandler());
    register(JdbcType.FLOAT, new FloatTypeHandler());

    register(Double.class, new DoubleTypeHandler());
    register(double.class, new DoubleTypeHandler());
    register(JdbcType.DOUBLE, new DoubleTypeHandler());

    register(String.class, new StringTypeHandler());
    register(String.class, JdbcType.CHAR, new StringTypeHandler());
    register(String.class, JdbcType.CLOB, new ClobTypeHandler());
    register(String.class, JdbcType.VARCHAR, new StringTypeHandler());
    register(String.class, JdbcType.LONGVARCHAR, new ClobTypeHandler());
    register(String.class, JdbcType.NVARCHAR, new NStringTypeHandler());
    register(String.class, JdbcType.NCHAR, new NStringTypeHandler());
    register(String.class, JdbcType.NCLOB, new NClobTypeHandler());
    register(JdbcType.CHAR, new StringTypeHandler());
    register(JdbcType.VARCHAR, new StringTypeHandler());
    register(JdbcType.CLOB, new ClobTypeHandler());
    register(JdbcType.LONGVARCHAR, new ClobTypeHandler());
    register(JdbcType.NVARCHAR, new NStringTypeHandler());
    register(JdbcType.NCHAR, new NStringTypeHandler());
    register(JdbcType.NCLOB, new NClobTypeHandler());

    register(Object.class, JdbcType.ARRAY, new ArrayTypeHandler());
    register(JdbcType.ARRAY, new ArrayTypeHandler());

    register(BigInteger.class, new BigIntegerTypeHandler());
    register(JdbcType.BIGINT, new LongTypeHandler());

    register(BigDecimal.class, new BigDecimalTypeHandler());
    register(JdbcType.REAL, new BigDecimalTypeHandler());
    register(JdbcType.DECIMAL, new BigDecimalTypeHandler());
    register(JdbcType.NUMERIC, new BigDecimalTypeHandler());

    register(Byte[].class, new ByteObjectArrayTypeHandler());
    register(Byte[].class, JdbcType.BLOB, new BlobByteObjectArrayTypeHandler());
    register(Byte[].class, JdbcType.LONGVARBINARY, new BlobByteObjectArrayTypeHandler());
    register(byte[].class, new ByteArrayTypeHandler());
    register(byte[].class, JdbcType.BLOB, new BlobTypeHandler());
    register(byte[].class, JdbcType.LONGVARBINARY, new BlobTypeHandler());
    register(JdbcType.LONGVARBINARY, new BlobTypeHandler());
    register(JdbcType.BLOB, new BlobTypeHandler());

    register(Object.class, UNKNOWN_TYPE_HANDLER);
    register(Object.class, JdbcType.OTHER, UNKNOWN_TYPE_HANDLER);
    register(JdbcType.OTHER, UNKNOWN_TYPE_HANDLER);

    register(Date.class, new DateTypeHandler());
    register(Date.class, JdbcType.DATE, new DateOnlyTypeHandler());
    register(Date.class, JdbcType.TIME, new TimeOnlyTypeHandler());
    register(JdbcType.TIMESTAMP, new DateTypeHandler());
    register(JdbcType.DATE, new DateOnlyTypeHandler());
    register(JdbcType.TIME, new TimeOnlyTypeHandler());

    register(java.sql.Date.class, new SqlDateTypeHandler());
    register(java.sql.Time.class, new SqlTimeTypeHandler());
    register(java.sql.Timestamp.class, new SqlTimestampTypeHandler());

    // issue #273
    register(Character.class, new CharacterTypeHandler());
    register(char.class, new CharacterTypeHandler());
  }

如上所示，這就是全部預設的typeHandler了，注意一下46，47行可以看到預設有一個ArrayTypeHandler，順便看一下它的原始碼：

/*
 *    Copyright 2009-2012 The MyBatis Team
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.type;

import java.sql.Array;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

public class ArrayTypeHandler extends BaseTypeHandler<Object> {

  public ArrayTypeHandler() {
    super();
  }

  @Override
  public void setNonNullParameter(PreparedStatement ps, int i, Object parameter, JdbcType jdbcType) throws SQLException {
    ps.setArray(i, (Array) parameter);
  }

  @Override
  public Object getNullableResult(ResultSet rs, String columnName) throws SQLException {
    Array array = rs.getArray(columnName);
    return array == null ? null : array.getArray();
  }

  @Override
  public Object getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
    Array array = rs.getArray(columnIndex);
    return array == null ? null : array.getArray();
  }

  @Override
  public Object getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
    Array array = cs.getArray(columnIndex);
    return array == null ? null : array.getArray();
  }

}

那它能否識別PostgreSQL的陣列型別並將它自動轉換成Java陣列型別呢？按官方的說法，既然這是預設的typeHandler，那麼我們無需做任何配置mybatis會自動嘗試適配，所以直接寫測試程式碼看看：

@Test
public void testFunc1() {
    SqlSession session = sqlSessionFactory.openSession();
    try {
        Map<String, Object> map = new HashMap<String, Object>();
        map.put("ids", new Integer[] { 101, 102, 103 });
        session.update("com.wl.entity.StudentMapper.testFuncUpdate2", map);
        session.commit();
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        session.close();
    }
}
<update id="testFuncUpdate2" statementType="CALLABLE">
    {call func_arr_update (#{ids,mode=IN})}  
</update>

如上所示，引數傳的是一個Integer[]，直接執行一下junit看看測試結果：
這裡寫圖片描述

Can’t infer the SQL type to use for an instance of [Ljava.lang.Integer;. Use setObject() with an explicit Types value to specify the type to use.

異常log如上所示，在呼叫AbstractJdbc2Statement類的setObject方法時丟擲異常，那麼再看看這個方法的原始碼：

    /*
     * This stores an Object into a parameter.
     */
    public void setObject(int parameterIndex, Object x) throws SQLException
    {
        checkClosed();
        if (x == null)
            setNull(parameterIndex, Types.OTHER);
        else if (x instanceof String)
            setString(parameterIndex, (String)x);
        else if (x instanceof BigDecimal)
            setBigDecimal(parameterIndex, (BigDecimal)x);
        else if (x instanceof Short)
            setShort(parameterIndex, ((Short)x).shortValue());
        else if (x instanceof Integer)
            setInt(parameterIndex, ((Integer)x).intValue());
        else if (x instanceof Long)
            setLong(parameterIndex, ((Long)x).longValue());
        else if (x instanceof Float)
            setFloat(parameterIndex, ((Float)x).floatValue());
        else if (x instanceof Double)
            setDouble(parameterIndex, ((Double)x).doubleValue());
        else if (x instanceof byte[])
            setBytes(parameterIndex, (byte[])x);
        else if (x instanceof java.sql.Date)
            setDate(parameterIndex, (java.sql.Date)x);
        else if (x instanceof Time)
            setTime(parameterIndex, (Time)x);
        else if (x instanceof Timestamp)
            setTimestamp(parameterIndex, (Timestamp)x);
        else if (x instanceof Boolean)
            setBoolean(parameterIndex, ((Boolean)x).booleanValue());
        else if (x instanceof Byte)
            setByte(parameterIndex, ((Byte)x).byteValue());
        else if (x instanceof Blob)
            setBlob(parameterIndex, (Blob)x);
        else if (x instanceof Clob)
            setClob(parameterIndex, (Clob)x);
        else if (x instanceof Array)
            setArray(parameterIndex, (Array)x);
        else if (x instanceof PGobject)
            setPGobject(parameterIndex, (PGobject)x);
        else if (x instanceof Character)
            setString(parameterIndex, ((Character)x).toString());
        else if (x instanceof Map)
            setMap(parameterIndex, (Map)x);
        else
        {
            // Can't infer a type.
            throw new PSQLException(GT.tr("Can''t infer the SQL type to use for an instance of {0}. Use setObject() with an explicit Types value to specify the type to use.", x.getClass().getName()), PSQLState.INVALID_PARAMETER_TYPE);
        }
    }

我們引數傳進去的Integer[]陣列是一個Object陣列，而 setObject(int parameterIndex, Object x)方法的第二個引數是Object，所以這裡這裡自然無法匹配也就報錯了，那麼換成int[]可以嗎？在上面的else if語句中明顯沒有x instanceof int[]這行程式碼，所以當然也不行，說到這裡也就明確了mybatis預設提供的ArrayTypeHandler是無法自動識別PostgreSQL的陣列型別，我們必須自定義一個引數為Object[]的ArrayTypeHandler才能實現匹配。

自定義ArrayTypeHandler

如題，先貼上程式碼：

package com.wl.util;

import java.sql.Array;
import java.sql.CallableStatement;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import org.apache.ibatis.type.MappedJdbcTypes;
import org.apache.ibatis.type.TypeException;

@MappedJdbcTypes(JdbcType.ARRAY)
public class ArrayTypeHandler extends BaseTypeHandler<Object[]> {

    private static final String TYPE_NAME_VARCHAR = "varchar";
    private static final String TYPE_NAME_INTEGER = "integer";
    private static final String TYPE_NAME_BOOLEAN = "boolean";
    private static final String TYPE_NAME_NUMERIC = "numeric";

    @Override
    public void setNonNullParameter(PreparedStatement ps, int i,
            Object[] parameter, JdbcType jdbcType) throws SQLException {

        String typeName = null;
        if (parameter instanceof Integer[]) {
            typeName = TYPE_NAME_INTEGER;
        } else if (parameter instanceof String[]) {
            typeName = TYPE_NAME_VARCHAR;
        } else if (parameter instanceof Boolean[]) {
            typeName = TYPE_NAME_BOOLEAN;
        } else if (parameter instanceof Double[]) {
            typeName = TYPE_NAME_NUMERIC;
        }

        if (typeName == null) {
            throw new TypeException(
                    "ArrayTypeHandler parameter typeName error, your type is "
                            + parameter.getClass().getName());
        }

        Connection conn = ps.getConnection();
        Array array = conn.createArrayOf(typeName, parameter);
        ps.setArray(i, array);
    }

    @Override
    public Object[] getNullableResult(ResultSet rs, String columnName)
            throws SQLException {

        return getArray(rs.getArray(columnName));
    }

    @Override
    public Object[] getNullableResult(ResultSet rs, int columnIndex)
            throws SQLException {

        return getArray(rs.getArray(columnIndex));
    }

    @Override
    public Object[] getNullableResult(CallableStatement cs, int columnIndex)
            throws SQLException {

        return getArray(cs.getArray(columnIndex));
    }

    private Object[] getArray(Array array) {

        if (array == null) {
            return null;
        }

        try {
            return (Object[]) array.getArray();
        } catch (Exception e) {
        }

        return null;
    }
}

如上所示，我們指定了引數型別為Object[]，這樣就可以接收Integer[]型別的引數了，關鍵是44~46行，postgresql的驅動類AbstractJdbc4Connection實現了Connect介面的createArrayOf方法，原始碼如下：

   public Array createArrayOf(String typeName, Object[] elements) throws SQLException
    {
        checkClosed();
        int oid = getTypeInfo().getPGArrayType(typeName);
        if (oid == Oid.UNSPECIFIED)
            throw new PSQLException(GT.tr("Unable to find server array type for provided name {0}.", typeName), PSQLState.INVALID_NAME);

        char delim = getTypeInfo().getArrayDelimiter(oid);
        StringBuffer sb = new StringBuffer();
        appendArray(sb, elements, delim);

        // This will not work once we have a JDBC 5,
        // but it'll do for now.
        return new Jdbc4Array(this, oid, sb.toString());
    }

這樣通過自定義的ArrayTypeHandler就可以在Mybatis中方便的運算元組型別資料了，最後再測試一下，測試類程式碼不變，僅需在呼叫儲存過程時指定mapper檔案的typeHandler即可：

@Test
public void testFunc1() {
    SqlSession session = sqlSessionFactory.openSession();
    try {
        Map<String, Object> map = new HashMap<String, Object>();
        map.put("ids", new Integer[] { 101, 102, 103 });
        session.update("com.wl.entity.StudentMapper.testFuncUpdate2", map);
        session.commit();
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        session.close();
    }
}
<update id="testFuncUpdate2" statementType="CALLABLE">
    {call func_arr_update (#{ids,mode=IN,typeHandler=com.wl.util.ArrayTypeHandler})}  
</update>

再次執行junit看一下測試結果：
這裡寫圖片描述
這裡寫圖片描述

如上所示，此時已經可以成功呼叫引數為Integer[]陣列的pg自定義函數了。

總結

簡單記錄一下在mybatis中呼叫postgresql自定義函式時傳遞陣列引數的解決方案，希望對遇到同樣問題的朋友有所幫助，The End。

相關推薦

Mybatis呼叫PostgreSQL儲存過程實現陣列入參傳遞

前言 專案中用到了Mybatis呼叫PostgreSQL儲存過程（自定義函式）相關操作，由於PostgreSQL自帶陣列型別，所以有一個自定義函式的入參就是一個int陣列，形如： CREATE OR REPLACE FUNCTION "public"."

mybatis 呼叫sqlserver 儲存過程

<select id="testStoredProcedure" statementType="CALLABLE" resultMap="TestMap"> <![CDATA[ {call AllNewcourse(${shopid},${cours

【mybatis】mybatis呼叫sqlserver儲存過程和表值函式

儲存過程和表值函式的區別 最簡單的區別是儲存過程是pr開頭的，而儲存過程是fn開頭的，表值函式返回的是一個表結構的結果。如果mybatis用呼叫儲存過程的方式去呼叫表值函式，就會丟擲以下的異常： exc

mybatis 呼叫oracle儲存過程，傳參、返回遊標的值獲取--示例

1，dao層程式碼 Integer currentlq_fsx = getSqlSession().selectOne("lqMapper.maxscore"); Map<String,Object> map = new HashMap<String,O

OCI 呼叫Oracle 儲存過程實現

OCI呼叫儲存過程 最近的風控框架開發中，遇到一個場景，即程式需要呼叫Oracle中的儲存過程，但是目前的框架中並不支援，只支援呼叫組裝好的SQL語句,即基本的資料庫增刪改查操作，這樣就需要開發OCI呼叫儲存過程。 基於這個需求，開始網上找尋資料。由於使用到

mybatis呼叫Oracle儲存過程返回結果集

在開發中，有時需要關聯幾張表來進行一些複雜的計算，此時可採用建立一張臨時表，將每次的資料計算後先存入臨時表，然後通過Oracle的遊標返回。 在mybatis中的呼叫如下： //呼叫語法格式，需要構造一個resultMap，用來接收返回的結果集 <select id

ASP.NET呼叫oracle儲存過程實現快速分頁

{ OracleConnection conn =new OracleConnection(ConfigurationSettings.AppSettings["OracleConnstr"].ToString()); OracleCommand cmd  =new OracleCommand(); cmd.

mybatis呼叫oracle儲存過程 返回sys_refcursor

Map<String, Object> map = new HashMap<String, Object>(); map.put("id", "0"); mapper.selectPosBy(map); return (List) map

mybatis呼叫mysql儲存過程返回結果集

儲存過程中經常需要返回結果集。Mysql中直接用select即可返回結果集。而oracle則需要使用遊標來返回結果集。這一點Mysql相對比較方便，如下程式碼即可實現輸出結果集： 儲存過程定義： D

mybatis呼叫oracle儲存過程

1.無輸入和輸出引數的儲存過程我寫了一個比較簡單的，需要注意的是Oracle無參儲存過程不能寫括號CREATE OR REPLACE Procedure cascadeoperation As Begin  Delete From teacher Where id=1;  U

SSM-Mybatis呼叫Oracle儲存過程返回結果集(遊標)示例

1.建立一個包 此處建立一個包,是為了建立儲存過程時,用遊標作為out輸出引數時宣告為遊標型別用的. --建立一個包 create or replace package types as type empListCursor is ref cursor

mybatis呼叫oracle儲存過程返回遊標 讀取到java的List

mapper： <select id="testP" statementType="CALLABLE" > {call P_TEST(#{v_cursor, mode=OUT, jdbcType=CURSOR})} </select> ja

mybatis呼叫mysql儲存過程（返回引數，單結果集，多結果集）

一、接收一個返回值 使用Map接收返回引數，output引數放在傳入的param中 建立表 DROP TABLE IF EXISTS `demo`; CREATE TABLE `demo` ( `id` int(11) NOT NULL AUTO_INCREMEN

mysql儲存過程以"陣列"形式入參實現表間複製 並實現回滾

這個程式碼是我需要實現，前端稽核某個稽核後，這個資料會在另一個頁面中呈現，涉及到兩個資料庫表。一下內容是用於測試的程式碼。 前端進行處理，將id封裝成陣列後提交到Java後臺，"陣列"使用 - 來分隔，是因為入參時，我使用了逗號，但是測試失敗了，就改用-或空格 在點提交後

[jdbctemplate+POSTGRESQL+儲存過程]jdbc呼叫儲存過程順便勘誤同時給出幾個較好的配合方式

前言 首先採用jdbc呼叫儲存過程是因為，整合mybatis的話，對於以儲存過程為主的系統沒有多大的幫助，反而多了一個分層。 本文將給出常見的儲存過程呼叫方式。 閱讀前可以先參考一下： 關於postgresql的多結果集，或者遊標返回儲存過程請檢視上篇文章： 【

MVC呼叫儲存過程實現分頁，帶查詢條件

alter procedure P_GetPagedUserInfoByCondition @PageSize int,--表示每頁要顯示的記錄數 @CurrentPageIndex int,--表示當前要顯示第幾頁的資料 @RecordCount int output,--表示滿足條

postgresql 儲存過程時 如何把查到資料放到陣列中,計算出陣列中數字個數字

  CREATE OR REPLACE FUNCTION 儲存過程名(     引數1 integer,     傳入字元數字 text,            //'1,2,3,'     )   RETURNS void AS             //無返回值 $B

使用mybatis給Oracle儲存過程傳List,陣列型別.

0.不廢話.直接上過程 1.因為Oracle本身是有陣列概念的.我們直接使用Oracle中的陣列,但需要先建立型別,varray也就是Oracle的陣列,100指定長度,of後面指定型別, CREATE OR REPLACE TYPE tables_array AS VA

java mybatis 執行 sqlserver儲存過程 xml 以及實現類

個人覺得用儲存過程來寫資料庫邏輯很方便，因為專案從資料庫到後端到前端都要去編寫。所以把所有的都分離。首先ssm的結構配置這裡就不說了，可以看我部落格ssm的2種配置。1、Mapper.javaimport java.util.List; import java.util.Ma

spring data jpa 如何呼叫mysql儲存過程？

  A:首先定義儲存過程依賴的jpa表：     @Entity     @Table(name="evenmngt_childthingtree_tmp")//資料庫中的表名     @Name