下载 示例代码（Visual Basic、C#、C++） Oracle 数据库 Oracle Data Provider for .NET

标签 dotnet, database, 全部

在适用于 Visual Studio .NET 2003 的 Oracle 数据库上构建 .NET 应用程序

了解构建使用 Oracle 数据库的 .NET 应用程序所涉及的基本但不可或缺的过程。

2008 年 9 月更新

阅读本指南的 Oracle 数据库 11g/Visual Studio .NET 2005 或 2008 版本

随着 Microsoft 的 .NET Framework 的逐渐流行，许多开发人员迫切想了解关于将 .NET 应用程序与 Oracle 集成的最佳方式的信息 — 不仅在基本的连通性方面，还包括与使用 Visual Studio.NET (VS.NET) 进行有效的应用程序开发的关系。

在本文中，我将说明构建使用 Oracle 数据库的 .NET 应用程序所涉及到的基本但不可或缺的过程，包括：

• 如何添加工程引用，以在您的 .NET 工程中支持 Oracle 类库
• 如何创建 Oracle 数据库连接字符串
• 如何使用 Connection、Command 和 DataReader 对象

关于如何保护应用程序的信息和上机操作，请参见我的文章“在 Oracle 数据库上保护 .NET 应用程序”。（另外，有关涉及一系列 Oracle .NET 应用程序生命周期问题的技术文章，请参见 OTN .NET 开发人员中心。）

请注意，免费的 Oracle Developer Tools for Visual Studio（可从 OTN 下载）提供了一个 Visual Studio 插件，该插件可以简化 Oracle 上的 .NET 应用程序开发，并使之更加直观。但在这里我们不讨论这个问题；要想了解这方面的更多信息，您可以前往 Oracle Developer Tools for Visual Studio 产品中心。

.NET 数据提供程序

除了基本的 Oracle 客户端连通性软件，.NET 应用程序还需要使用称为 受管理的数据提供程序（其中“受管理的”指的是代码由 .NET 框架管理）的工具。数据提供程序是指 .NET 应用程序代码和 Oracle 客户端连通性软件之间的层。几乎在所有情况下，最优的性能都是通过使用为特定数据库平台优化了的提供程序而不是通用的 .NET OLE DB 数据提供程序实现的。

Oracle、Microsoft 和第三方供应商都提供针对 Oracle 产品进行了优化的 .NET 数据提供程序。Oracle 和 Microsoft 免费提供其 Oracle 数据提供程序。（Microsoft 针对 .NET Framework 1.1 的提供程序包括在该框架中，但仍然需要 Oracle 客户端软件安装。）在本文中，我们将使用 Oracle Data Provider for .NET (ODP.NET)，它包含在 Oracle 数据库中或者单独提供下载。

ODP.NET 提供标准的 ADO.NET 数据库访问，同时还提供专用于 Oracle 数据库的特性，如 XML DB、数据访问性能优化和真正应用集群连接池。

安装了 ODP.NET 和 Oracle 客户端软件后，就可以开始使用 Visual Studio 进行应用程序开发了。在开始开发前，请先确认客户端连通性。如果您可以使用 Visual Studio 所在计算机上的 Oracle 客户端软件（如 SQL*Plus）连接到 Oracle，您就知道 Oracle 客户端软件已经正确安装并配置。

如果您是初次接触 Oracle，请参阅 Oracle 数据库两日开发人员指南 中的“安装 .NET 产品”一节，以便具体了解有关如何安装和配置 ODP.NET 的信息，也可以参阅 Oracle 数据库文档库了解有关 Oracle 数据库的常规信息。

在 Visual Studio.NET 中创建工程

在启动 VS.NET 之后，第一个任务是创建一个工程。您可以单击 New Project 按钮或选择 File | New | Project... （如下所示）。

图 1：在 Visual Studio.NET 中创建一个新工程

出现一个 New Project 对话框。在对话框左侧的 Project Types 下，选择您的编程语言。在这个例子中，我们选择 VB.NET。在右侧的 Templates 下，选择一个工程模板。为简单起见，这里选择 Windows Application。

图 2：使用 New Project 对话框

您将需要为工程名称（我们使用 OraWinApp）和解决方案名称（我们使用 OraSamples）指定有意义的名称。一个解决方案包含一个或多个工程。当一个解决方案仅包含一个工程时，许多人对二者使用相同的名称。

添加引用

因为我们的工程必须与 Oracle 数据库连接，因此必须添加一个到包含我们选择的数据提供程序的 dll 的引用。在 Solution Explorer 内，选择 References 节点，右键单击并选择 Add Reference。或者，您可以转至菜单栏并选择 Project ，然后选择 Add Reference 。

图 3：添加引用

出现 Add Reference 对话框。

图 4：选择 ODP.NET 管理的数据提供程序

从列表中选择 Oracle.DataAccess.dll，然后单击 S elect 按钮，最后单击 OK 按钮，使您的工程识别 ODP.NET 数据提供程序。

图 5：选择 Oracle 管理的提供程序之后的 Solution Explorer

VB.NET/C# 语句

在添加引用之后，标准的做法是要添加 VB.NET Imports 语句、C# using 语句或 J# import 语句。从技术上说这些语句不是必要的，但是使用它们可以让您不需用冗长且完全限定名称来引用数据库对象。

Imports Oracle.DataAccess.Client ' VB.NET

using Oracle.DataAccess.Client;  // C#

import Oracle.DataAccess.Client; // J#ODP.NET Oracle managed provider

连接字符串和对象

Oracle 连接字符串和 Oracle 名称解析是不可分的。假定我们在 tnsnames.ora 文件中定义了一个数据库别名 OraDb，如下：

OraDb=
  (DESCRIPTION=
    (ADDRESS_LIST=
      (ADDRESS=(PROTOCOL=TCP)(HOST=OTNSRVR)(PORT=1521))
    )
    (CONNECT_DATA=
      (SERVER=DEDICATED)
      (SERVICE_NAME=ORCL)
    )
  )

Dim oradb As String = "Data Source=OraDb;User Id=scott;Password=tiger;" ' VB.NET

string oradb = "Data Source=OraDb;User Id=scott;Password=tiger;"; // C#

' VB.NET 
Dim oradb As String = "Data Source=(DESCRIPTION=" _
           + "(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=OTNSRVR)(PORT=1521)))" _
           + "(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=ORCL)));" _
           + "User Id=scott;Password=tiger;"

// C#
string oradb = "Data Source=(DESCRIPTION="
             + "(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=ORASRVR)(PORT=1521)))"
             + "(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=ORCL)));"
             + "User Id=scott;Password=tiger;";

Dim conn As New OracleConnection(oradb) ' VB.NET

OracleConnection conn = new OracleConnection(oradb); // C#

Dim conn As New OracleConnection() ' VB.NET
conn.ConnectionString = oradb

OracleConnection conn = new OracleConnection(); // C#
conn.ConnectionString = oradb;

conn.Open() ' VB.NET

conn.Open(); // C#

Command 对象

Command 对象用于指定执行的 SQL 命令文本 — SQL 字符串或存储过程。类似于 Connection 对象，它必须从完成其类的实例化，并且它拥有一个重载的构造函数。在本示例中，ODP.NET 将执行一个 SQL 查询，返回部门表 (DEPT) 中部门编号 (DEPTNO) 为 10 的部门名称 (DNAME)。

Dim sql As String = "select dname from dept where deptno = 10" ' VB.NET
Dim cmd As New OracleCommand(sql, conn)
cmd.CommandType = CommandType.Text

string sql = "select dname from dept where deptno = 10"; // C#
OracleCommand cmd = new OracleCommand(sql, conn);
cmd.CommandType = CommandType.Text;

从数据库中检索数据可以通过实例化一个 OracleDataReader 对象并使用 ExecuteReader 方法（它返回一个 OracleDataReader 对象）来实现。可以通过将列名或以零为基数的列序号传递给 OracleDataReader 来访问返回的数据。

Dim dr As OracleDataReader = cmd.ExecuteReader() ' Visual Basic
dr.Read()

Label1.Text = dr.Item("dname") ' retrieve by column name
Label1.Text = dr.Item(0) ' retrieve the first column in the select list
Label1.Text = dr.GetString(0) ' return a .NET data type
Label1.Text = dr.GetOracleString(0) ' return an Oracle data type

OracleDataReader dr = cmd.ExecuteReader(); // C#
dr.Read();

label1.Text = dr["dname"].ToString(); // C# retrieve by column name
label1.Text = dr.GetString(0).ToString();  // return a .NET data type
label1.Text = dr.GetOracleString(0).ToString();  // return an Oracle data type

Label1.Text = CStr(dr.Item("deptno")) ' Visual Basic integer to string cast

label1.Text = dr.GetInt16("deptno").ToString(); // C#

关闭并清除

当不在需要到数据库的连接时，可以调用连接对象的 Close 方法或 Dispose 方法来关闭此连接。Dispose 方法调用 Close 方法。

conn.Close()   ' Visual Basic
conn.Dispose() ' Visual Basic

conn.Close();   // C#
conn.Dispose(); // C#

using (OracleConnection conn = new OracleConnection(oradb))
{
    conn.Open();

    OracleCommand cmd = new OracleCommand();
    cmd.Connection = conn;
    cmd.CommandText = "select dname from dept where deptno = 10";
    cmd.CommandType = CommandType.Text;
        
    OracleDataReader dr = cmd.ExecuteReader();
    dr.Read();

    label1.Text = dr.GetString(0);
}

错误处理

当错误发生时，.NET 应用程序应当适当地处理错误并通过一条有意义的消息通知用户。

Try-Catch-Finally 结构的错误处理是 .NET 语言的一部分。下面是使用 Try-Catch-Finally 语法的一个相对最小的示例：

' Visual Basic

Try
    conn.Open()

    Dim cmd As New OracleCommand
    cmd.Connection = conn
    cmd.CommandText = "select dname from dept where deptno = " + TextBox1.Text
    cmd.CommandType = CommandType.Text

    If dr.Read() Then
        Label1.Text = dr.Item("dname") ' or use dr.Item(0)
    End If
Catch ex As Exception ' catches any error
    MessageBox.Show(ex.Message.ToString())
Finally
    ' In a real application, put cleanup code here.

End Try

// C#

try
{
    conn.Open();

    OracleCommand cmd = new OracleCommand();
    cmd.Connection = conn;
    cmd.CommandText = "select dname from dept where deptno = " + textBox1.Text;
    cmd.CommandType = CommandType.Text;

    if (dr.Read()) // C#
    {
        label1.Text = dr["dname"].ToString();
                   // or use dr.GetOracleString(0).ToString()
    }
}
catch (Exception ex) // catches any error
{
    MessageBox.Show(ex.Message.ToString());
}
finally
{
    // In a real application, put cleanup code here.

}

图 6：捕获到一个 ORA-12545 错误，并向用户显示。

Oracle DBA 或开发人员很清楚 ORA-12545 的意义，但是最终用户不清楚。一种更好的解决方案是添加一条额外的 Catch 语句来捕获最常见的数据库错误并显示对用户友好的消息。

Catch ex As OracleException ' catches only Oracle errors
    Select Case ex.Number
        Case 1
            MessageBox.Show("Error attempting to insert duplicate data.")
        Case 12545
            MessageBox.Show("The database is unavailable.")
        Case Else
            MessageBox.Show("Database error: " + ex.Message.ToString())
    End Select
Catch ex As Exception ' catches any error
    MessageBox.Show(ex.Message.ToString())

catch (OracleException ex) // catches only Oracle errors
{
    switch (ex.Number)
    {
        case 1:
            MessageBox.Show("Error attempting to insert duplicate data.");
            break;
        case 12545:
            MessageBox.Show("The database is unavailable.");
            break;
        default:
            MessageBox.Show("Database error: " + ex.Message.ToString());
            break;
    }
}
catch (Exception ex) // catches any error
{
    MessageBox.Show(ex.Message.ToString());
}

图 7：ORA-12545 错误的用户友好的错误消息

无论是否发生错误， Finally 代码块总会执行。清除代码应包含在此代码块中。如果您不使用 Using 或 using，应在 Finally 代码块中删除您的连接和其他对象。

利用 DataReader 检索多个值

到目前为止，我们的示例仅说明了如何检索单个值。OracleDataReader 可以检索多列和多行的值。首先进行多列、单行的查询：

select deptno, dname, loc from dept where deptno = 10

下面是将 DNAME 和来自上一查询的 LOC 列串连起来的代码片段：

Label1.Text = "The " + dr.Item("dname") + " department is in " + dr.Item("loc") ' VB

label1.Text = "The " + dr["dname"].ToString() + " department is in " + 
              dr["loc"].ToString();  // C#

select deptno, dname, loc from dept

While dr.Read() ' Visual Basic
   ListBox1.Items.Add("The " + dr.Item("dname") + " department is in " + dr.Item("loc"))
End While

while (dr.Read()) // C#
{
    listBox1.Items.Add("The " + dr["dname"].ToString() + " department is in " +
                       dr["loc"].ToString());
}

总结

本文向您介绍了使用 VS.NET 编程语言访问 Oracle 数据库的过程。您现在应该能够连接数据库并检索多列和多行。