Java資料庫程式中的預存程序設計

程式|預存程序|設計|資料|資料庫 　　本文闡述了怎麼使用DBMS預存程序。闡述了使用預存程序的基本的和進階特性，比如返回ResultSet。本文假設你對DBMS和JDBC已經非常熟悉，也假設你能夠毫無障礙地閱讀其它語言寫成的代碼（即不是Java的語言），但是，並不要求你有任何預存程序的編程經曆。

　　預存程序是指儲存在資料庫並在資料庫端執行的程式。你可以使用特殊的文法在Java類中調用預存程序。在調用時，預存程序的名稱及指定的參數通過JDBC串連發送給DBMS，執行預存程序並通過串連（如果有）返回結果。

　　使用預存程序擁有和使用基於EJB或CORBA這樣的應用伺服器一樣的好處。區別是預存程序可以從很多流行的DBMS中免費使用，而應用伺服器大都非常昂貴。這並不只是許可證費用的問題。使用應用伺服器所需要花費的管理、編寫代碼的費用，以及客戶程式所增加的複雜性，都可以通過DBMS中的預存程序所整個地替代。

　　你可以使用Java，Python，Perl或C編寫預存程序，但是通常使用你的DBMS所指定的特定語言。Oracle使用PL/SQL，PostgreSQL使用pl/pgsql，DB2使用Procedural SQL。這些語言都非常相似。在它們之間移植預存程序並不比在Sun的EJB規範不同實現版本之間移植Session Bean困難。並且，預存程序是為嵌入SQL所設計，這使得它們比Java或C等語言更加友好地方式表達資料庫的機制。

　　因為預存程序運行在DBMS自身，這可以協助減少應用程式中的等待時間。不是在Java代碼中執行4個或5個SQL語句，而只需要在伺服器端執行1個預存程序。網路上的資料往返次數的減少可以戲劇性地最佳化效能。

　　 使用預存程序

　　簡單的老的JDBC通過CallableStatement類支援預存程序的調用。該類實際上是PreparedStatement的一個子類。假設我們有一個poets資料庫。資料庫中有一個設定詩人逝世年齡的預存程序。下面是對老酒鬼Dylan Thomas（old soak Dylan Thomas，不指定是否有關典故、文化，請批評指正。譯註）進行調用的詳細代碼：

try
{
　int age = 39;
　String poetName = "dylan thomas";
　CallableStatement proc = connection.prepareCall("{ call set_death_age(?, ?) }");
　proc.setString(1, poetName);
　proc.setInt(2, age);
　cs.execute();
}
catch (SQLException e)
{
　// ....
}
　　傳給prepareCall方法的字串是預存程序調用的書寫規範。它指定了預存程序的名稱，？代表了你需要指定的參數。

　　和JDBC整合是預存程序的一個很大的便利：為了從應用中調用預存程序，不需要存根（stub）類或者設定檔，除了你的DBMS的JDBC驅動程式外什麼也不需要。

　　當這段代碼執行時，資料庫的預存程序就被調用。我們沒有去擷取結果，因為該預存程序並不返回結果。執行成功或失敗將通過例外得知。失敗可能意味著調用預存程序時的失敗（比如提供的一個參數的類型不正確），或者一個應用程式的失敗（比如拋出一個例外指示在poets資料庫中並不存在“Dylan Thomas”）

　　 結合SQL操作與預存程序

　　映射Java對象到SQL表中的行相當簡單，但是通常需要執行幾個SQL語句；可能是一個SELECT尋找ID，然後一個INSERT插入指定ID的資料。在高度規格化（符合更高的範式，譯註）的資料庫模式中，可能需要多個表的更新，因此需要更多的語句。Java代碼會很快地膨脹，每一個語句的網路開銷也迅速增加。

　　將這些SQL語句轉移到一個預存程序中將大大簡化代碼，僅涉及一次網路調用。所有關聯的SQL操作都可以在資料庫內部發生。並且，預存程序語言，例如PL/SQL，允許使用SQL文法，這比Java代碼更加自然。下面是我們早期的預存程序，使用Oracle的PL/SQL語言編寫：

create procedure set_death_age(poet VARCHAR2, poet_age NUMBER)
poet_id NUMBER;
begin
SELECT id INTO poet_id FROM poets WHERE name = poet;
INSERT INTO deaths (mort_id, age) VALUES (poet_id, poet_age);
end set_death_age;
　　很獨特？不。我打賭你一定期待看到一個poets表上的UPDATE。這也暗示了使用預存程序實現是多麼容易的一件事情。set_death_age幾乎可以肯定是一個很爛的實現。我們應該在poets表中添加一列來儲存逝世年齡。Java代碼中並不關心資料庫模式是怎麼實現的，因為它僅調用預存程序。我們以後可以改變資料庫模式以提高效能，但是我們不必修改我們代碼。

　　下面是調用上面預存程序的Java代碼：

public static void setDeathAge(Poet dyingBard, int age)
throws SQLException
{
　Connection con = null;
　CallableStatement proc = null;

　try
　{
　　con = connectionPool.getConnection();
　　proc = con.prepareCall("{ call set_death_age(?, ?) }");
　　proc.setString(1, dyingBard.getName());
　　proc.setInt(2, age);
　　proc.execute();
　}
　finally
　{
　　try
　　{
　　　proc.close();
　　}
　　catch (SQLException e) {}
　　con.close();
　}
}
　　為了確保可維護性，建議使用像這兒這樣的static方法。這也使得調用預存程序的代碼集中在一個簡單的模版代碼中。如果你用到許多預存程序，就會發現僅需要拷貝、粘貼就可以建立新的方法。因為代碼的模版化，甚至也可以通過指令碼自動生產調用預存程序的代碼。

　　Functions

　　預存程序可以有傳回值，所以CallableStatement類有類似getResultSet這樣的方法來擷取傳回值。當預存程序返回一個值時，你必須使用registerOutParameter方法告訴JDBC磁碟機該值的SQL類型是什麼。你也必須調整預存程序調用來指示該過程返回一個值。

　　下面接著上面的例子。這次我們查詢Dylan Thomas逝世時的年齡。這次的預存程序使用PostgreSQL的pl/pgsql：

create function snuffed_it_when (VARCHAR) returns integer '
declare
poet_id NUMBER;
poet_age NUMBER;
begin
-- first get the id associated with the poet.
SELECT id INTO poet_id FROM poets WHERE name = $1;
-- get and return the age.
SELECT age INTO poet_age FROM deaths WHERE mort_id = poet_id;
return age;
end;
' language 'pl/pgsql';
　　另外，注意pl/pgsql參數名通過Unix和DOS指令碼的$n文法引用。同時，也注意嵌入的注釋，這是和Java代碼相比的另一個優越性。在Java中寫這樣的注釋當然是可以的，但是看起來很淩亂，並且和SQL語句脫節，必須嵌入到Java String中。

　　下面是調用這個預存程序的Java代碼：

connection.setAutoCommit(false);
CallableStatement proc =
connection.prepareCall("{ ? = call snuffed_it_when(?) }");
proc.registerOutParameter(1, Types.INTEGER);
proc.setString(2, poetName);
cs.execute();
int age = proc.getInt(2);

　　如果指定了錯誤的傳回值類型會怎樣？那麼，當調用預存程序時將拋出一個RuntimeException，正如你在ResultSet操作中使用了一個錯誤的類型所碰到的一樣。

　　複雜的傳回值

　　關於預存程序的知識，很多人好像就熟悉我們所討論的這些。如果這是預存程序的全部功能，那麼預存程序就不是其它遠程執行機制的替換方案了。預存程序的功能比這強大得多。

　　當你執行一個SQL查詢時，DBMS建立一個叫做cursor（遊標）的資料庫物件，用於在返回結果中迭代每一行。ResultSet是目前時間點的遊標的一個表示。這就是為什麼沒有緩衝或者特定資料庫的支援，你只能在ResultSet中向前移動。

　　某些DBMS允許從預存程序中返回遊標的一個引用。JDBC並不支援這個功能，但是Oracle、PostgreSQL和DB2的JDBC磁碟機都支援在ResultSet上開啟到遊標的指標（pointer）。

　　設想列出所有沒有活到退休年齡的詩人，下面是完成這個功能的預存程序，返回一個開啟的遊標，同樣也使用PostgreSQL的pl/pgsql語言：

create procedure list_early_deaths () return refcursor as '
declare
toesup refcursor;
begin
open toesup for
SELECT poets.name, deaths.age
FROM poets, deaths
-- all entries in deaths are for poets.
-- but the table might become generic.
WHERE poets.id = deaths.mort_id
AND deaths.age < 60;
return toesup;
end;
' language 'plpgsql';
　　下面是調用該預存程序的Java方法，將結果輸出到PrintWriter：

PrintWriter:

static void sendEarlyDeaths(PrintWriter out)
{
　Connection con = null;
　CallableStatement toesUp = null;
　try
　{
　　con = ConnectionPool.getConnection();

　　// PostgreSQL needs a transaction to do this...
　　con.setAutoCommit(false);

　　// Setup the call.
　　CallableStatement toesUp= connection.prepareCall("{ ? = call list_early_deaths () }");
　　toesUp.registerOutParameter(1, Types.OTHER);
　　getResults.execute();

　　ResultSet rs = (ResultSet) getResults.getObject(1);
　　while (rs.next())
　　{
　　　String name = rs.getString(1);
　　　int age = rs.getInt(2);
　　　out.println(name + " was " + age + " years old.");
　　}
　　rs.close();
　}
　catch (SQLException e)
　{
　　// We should protect these calls.
　　toesUp.close();
　　con.close();
　}
}
　　因為JDBC並不直接支援從預存程序中返回遊標，我們使用Types.OTHER來指示預存程序的傳回型別，然後調用getObject()方法並對傳回值進行強制類型轉換。

　　這個調用預存程序的Java方法是mapping的一個好例子。Mapping是對一個集上的操作進行抽象的方法。不是在這個過程上返回一個集，我們可以把操作傳送進去執行。本例中，操作就是把ResultSet列印到一個輸出資料流。這是一個值得舉例的很常用的例子，下面是調用同一個預存程序的另外一個方法實現：

public class ProcessPoetDeaths
{
　public abstract void sendDeath(String name, int age);
}

static void mapEarlyDeaths(ProcessPoetDeaths mapper)
{
　Connection con = null;
　CallableStatement toesUp = null;
　try
　{
　　con = ConnectionPool.getConnection();
　　con.setAutoCommit(false);

　　CallableStatement toesUp= connection.prepareCall("{ ? = call list_early_deaths () }");
　　toesUp.registerOutParameter(1, Types.OTHER);
　　getResults.execute();

　　ResultSet rs = (ResultSet) getResults.getObject(1);
　　while (rs.next())
　　{
　　　String name = rs.getString(1);
　　　int age = rs.getInt(2);
　　　mapper.sendDeath(name, age);
　　}
　　rs.close();
　}
　catch (SQLException e)
　{
　　// We should protect these calls.
　　toesUp.close();
　　con.close();
　}
}
　　這允許在ResultSet資料上執行任意的處理，而不需要改變或者複製擷取ResultSet的方法：

static void sendEarlyDeaths(final PrintWriter out)
{
　ProcessPoetDeaths myMapper = new ProcessPoetDeaths()
　{
　　public void sendDeath(String name, int age)
　　{
　　　out.println(name + " was " + age + " years old.");
　　}
　};
　mapEarlyDeaths(myMapper);
}
　　這個方法使用ProcessPoetDeaths的一個匿名執行個體調用mapEarlyDeaths。該執行個體擁有sendDeath方法的一個實現，和我們上面的例子一樣的方式把結果寫入到輸出資料流。當然，這個技巧並不是預存程序特有的，但是和預存程序中返回的ResultSet結合使用，是一個非常強大的工具。

　　結論

　　預存程序可以協助你在代碼中分離邏輯，這基本上總是有益的。這個分離的好處有：

　　·快速建立應用，使用和應用一起改變和改善的資料庫模式。

　　·資料庫模式可以在以後改變而不影響Java對象，當我們完成應用後，可以重新設計更好的模式。

　　·預存程序通過更好的SQL嵌入使得複雜的SQL更容易理解。

　　·編寫預存程序比在Java中編寫嵌入的SQL擁有更好的工具－－大部分編輯器都提供文法高亮！

　　·預存程序可以在任何SQL命令列中測試，這使得調試更加容易。

　　並不是所有的資料庫都支援預存程序，但是存在許多很棒的實現，包括免費/開源的和非免費的，所以移植並不是一個問題。Oracle、PostgreSQL和DB2都有類似的預存程序語言，並且有線上的社區很好地支援。

　　預存程序工具很多，有像TOAD或TORA這樣的編輯器、調試器和IDE，提供了編寫、維護PL/SQL或pl/pgsql的強大的環境。

　　預存程序確實增加了你的代碼的開銷，但是它們和大多數的應用伺服器相比，開銷小得多。如果你的代碼複雜到需要使用DBMS，我建議整個採用預存程序的方式。