編寫資料庫操作類，讓ASP.NET中的資料庫操作變得簡單

作者：Willmove
首頁： http://www.amuhouse.com
E-mail: [email protected]
聲明：係作者原創作品，轉載請註明出處。

ASP.NET中一般都是使用SQL Server作為後台資料庫。一般的ASP.NET資料庫操作範例程式都是使用單獨的數據訪問，就是說每個頁面都寫連接到資料庫，訪問數據，關閉資料庫的程式碼。這種方式帶來了一些弊端，一個就是如果你的資料庫改變了，你必須一個頁面一個頁面的去更改資料庫連接程式碼。
第二個弊端就是程式碼冗餘，很多程式碼都是重複的，不必要的。
因此，我試圖透過一個一致的資料庫操作類別來實現ASP.NET種的資料存取。

我們就拿一般網站上都會有的新聞發布系統來做例子，它需要一個文章資料庫，我們把這個資料庫命名為News_Articles。新聞發布系統涉及發布新聞，展示文章，管理文章等。

一篇文章一般都會有標題，作者，發表時間，內容，另外我們需要把它們編號。我們把它寫成一個類，叫Article 類，程式碼如下：

//Article.cs
using System;

namespace News_Articles.Data
{
/// <summary>
/// Summary description for Article.
/// </summary>
public class Article
{
private int _id; //文章編號
private string _author; //文章的作者
private string _topic; //文章的標題
private DateTime _postTime; //文章的發佈時間
private string _content; //文章內容

public int ID
{
get { return _id;}
設定 { _id = value;}
}
public string Author
{
get { return _author; }
設定 { _author = value; }
}
public string Topic
{
get { return _topic; }
set { _topic = value; }
}
public string Content
{
get { return _content; }
設定 { _content = value; }
}
public DateTime PostTime
{
get { return _postTime; }
設定 { _postTime = value; }
}
}
}

然後我們寫一個文章集合類別ArticleCollection
程式碼如下

程式碼

//ArticleCollection.cs
using System[color=#0000ff];
using System.Collections;

namespace News_Articles.Data
{
/// <summary>
/// 文章的集合類，繼承於ArrayList
/// </summary>
public class ArticleCollection : ArrayList
{
public ArticleCollection() : base()
{
}

public ArticleCollection(ICollection c) : base(c)
{
}
}
}[/color]

這個類別相當於一個ASP.NET中的DataSet(其實兩者很不一樣)，很簡單，主要的目的是把將很多篇文章集合，以便在ASP.NET頁面中給DataGrid或者DataList作為資料來源，以顯示文章。

現在我們可以實現對News_Articles資料庫的操作了，我說過，這是一個資料庫操作類別。不妨命名為ArticleDb。實作如下：

程式碼

//ArticleDb.cs
using System;
using System.Configuration;
using System.Data;
using System.Data.SqlClient;

namespace News_Articles.Data
{
/**//// <summary>
/// 資料庫操作類，實作文章資料庫的讀取，插入，更新，刪除
/// </summary>
public class ArticleDb
{
private SqlConnection _conn; //SQL Server 資料庫連接
private string _articledb = "News_Articles"; //SQL Server 文章資料庫表

/**//// <summary>
/// 類別的初始化，設定資料庫連接
/// </summary>
public ArticleDb()
{
_conn = new SqlConnection(ConfigurationSettings.AppSettings["connectionString"]);
}

/**//// <summary>
/// 開啟資料庫連接
/// </summary>
public void Open()
{
if(_conn.State == ConnectionState.Closed)
_conn.Open();
}

/**//// <summary>
/// 關閉資料庫連接
/// </summary>
public void Close()
{
if(_conn.State == ConnectionState.Open)
_conn.Close();
}

/**//// <summary>
/// 讀取資料庫中所有的文章
/// </summary>
/// <returns>ArticleCollection</returns>
public ArticleCollection GetArticles()
{
ArticleCollection articles = new ArticleCollection();
string sql = "Select * FROM " + _articledb;
SqlCommand cmd = new SqlCommand(sql,_conn);
SqlDataReader dr = cmd.ExecuteReader();
while(dr.Read())
{
Article art = PopulateArticle(dr);
articles.Add(art);
}
dr.Close();
return articles;
}

/**//// <summary>
/// 給定一個文章編號， 讀取資料庫中的一篇文章
/// </summary>
/// <returns>Article</returns>
public Article GetArticle(int articleId)
{
string sql = "Select * FROM " + _articledb + "Where ID='" + articleId + "'";
SqlCommand cmd = new SqlCommand(sql,_conn);
SqlDataReader dr = cmd.ExecuteReader();
Article article = PopulateArticle(dr);
dr.Close();
return article;
}

/**//// <summary>
/// 更新資料庫記錄，注意需要設定文章的編號
/// </summary>
/// <param name="article"></param>
public void UpdateArticle(Article article)
{
string sql = "Update " + _articledb +" SET Topic=@topic,Author=@author,Content=@content,PostTime=@postTime "
+ " Where ID = @articleId";
SqlCommand cmd = new SqlCommand(sql,_conn);

cmd.Parameters.Add("@articleId",SqlDbType.Int,4).Value = article.ID;
cmd.Parameters.Add("@topic",SqlDbType.NVarChar,100).Value = article.Topic;
cmd.Parameters.Add("@author",SqlDbType.NVarChar,100).Value = article.Author;
cmd.Parameters.Add("@content",SqlDbType.NText).Value = article.Content;
cmd.Parameters.Add("@postTime",SqlDbType.DateTime).Value = article.PostTime;

cmd.ExecuteNonQuery();

}

/**//// <summary>
/// 取出資料庫中特定作者發表的文章
/// </summary>
/// <param name="author"></param>
/// <returns>ArticleCollection</returns>
public ArticleCollection GetArticlesByAuthor(string author)
{
string sql = "Select * FROM " + _articledb +" Where Author='" + author + "'";
SqlCommand cmd = new SqlCommand(sql, _conn);

ArticleCollection articleCollection = new ArticleCollection();

SqlDataReader dr = cmd.ExecuteReader();

while (dr.Read())
{
Article a = PopulateArticle(dr);
articleCollection.Add(a);
}
dr.Close();
return articleCollection;

}

/**//// <summary>
/// 刪除給定編號的一篇文章
/// </summary>
/// <param name="articleID"></param>
public void DeleteArticle(int articleID)
{
string sql = "Delete FROM " + _articledb + " Where ID='" + articleID + "'";
SqlCommand cmd = new SqlCommand(sql, _conn);
cmd.ExecuteNonQuery();
}

/**//// <summary>
/// 透過SqlDataReader 產生文章對象
/// </summary>
/// <param name="dr"></param>
/// <returns></returns>
private Article PopulateArticle(SqlDataReader dr)
{
Article art = new Article();

art.ID = Convert.ToInt32(dr["ID"]);
art.Author = Convert.ToString(dr["Author"]);
art.Topic = Convert.ToString(dr["Topic"]);

art.Content = Convert.ToString(dr["Content"]);
art.PostTime= Convert.ToDateTime(dr["PostTime"]);

return art;
}

/**//// <summary>
/// 增加一篇文章到資料庫中，回傳文章的編號
/// </summary>
/// <param name="article"></param>
/// <returns>剛剛插入的文章的編號</returns>
public int AddPost(Article article)
{
string sql = "Insert INTO " + _articledb +"(Author,Topic,Content,PostTime)"+
"VALUES(@author, @topic, @content, @postTime) "+
"Select @postID = @@IDENTITY";
SqlCommand cmd = new SqlCommand(sql,_conn);
cmd.Parameters.Add("@postID",SqlDbType.Int,4);
cmd.Parameters["@postID"].Direction = ParameterDirection.Output;

cmd.Parameters.Add("@author",SqlDbType.NVarChar,100).Value = article.Author;
cmd.Parameters.Add("@topic",SqlDbType.NVarChar,400).Value = article.Topic;
cmd.Parameters.Add("@content",SqlDbType.Text).Value = article.Content;
cmd.Parameters.Add("@postTime",SqlDbType.DateTime).Value = article.PostTime;

cmd.ExecuteNonQuery();

article.ID = (int)cmd.Parameters["@postID"].Value;
return article.ID;

}
}
}

基本的框架已經出來了。如果我們要在一個ASP.NET頁面中顯示文章資料庫News_Artices的數據，那麼只需要新增一個DataGrid 或DataList，然後綁定資料來源。例如在Default.aspx 中加入一個DataGrid ，命名為ArticlesDataGrid，在後台程式碼Default.aspx.cs 中加入

程式碼
using News_Articles.Data;

並在Page_Load 中加入如下的程式碼：

程式碼
private void Page_Load(object sender, System.EventArgs e)
{
// Put user code to initialize the page here
ArticleDb myArticleDb = new ArticleDb();
myArticleDb.Open();
ArticleCollection articles = myArticleDb.GetArticles();
this.ArticlesDataGrid.DataSource = articles;
if(!Page.IsPostBack)
{
this.ArticlesDataGrid.DataBind();
}

myArticleDb.Close();
}

這樣就可以實作讀取文章資料庫中所有文章。
如果需要刪除一篇文章那麼新增以下程式碼：

程式碼

//刪除編號為1 的文章
myArticleDb.DeleteArticle(1);

插入一篇文章，程式碼如下：

程式碼
//插入一篇新的文章,不需要指定文章編號，文章編號插入成功後由SQL Server傳回。
Article newArticle = new Article();
newArticle.Author = "Willmove";
newArticle.Topic = "測試插入一篇新的文章";
newArticle.Content = "這是我寫的文章的內容";
newArticle.PostTime = DateTime.Now;
int articleId = myArticleDb.AddPost(newArticle);

更新一篇文章，程式碼如下：

程式碼
//更新一篇文章,注意需要指定文章的編號
Article updateArticle = new Article();
updateArticle.ID = 3; //注意需要指定文章的編號
updateArticle.Author = "Willmove";
updateArticle.Topic = "測試更新資料";
updateArticle.Content = "這是我更新的文章的內容";
updateArticle.PostTime = DateTime.Now;
myArticleDb.UpdateArticle(updateArticle);

以上只是一個框架，具體的實作還有很多細節沒有列出來。但是基於上面的框架，你可以比較方便的寫出對資料庫操作的程式碼。另外一個建議就是把上面的資料庫存取的SQL 語句寫成資料庫預存過程，例如加入一篇文章:

程式碼
Create PROCEDURE AddPost
(
@ID int OUTPUT,
@Author nvarchar(100),
@Topic nvarchar(100),
@Content ntext,
@PostTime datetime
)
AS
Insert INTO News_Articles(Author, Topic, Content, PostTime) VALUES (@Author, @Topic, @Content, @PostTime);
Select @ID = @@IDENTITY
GO

附1：News_Articles 資料庫的字段

程式碼

欄位名稱描述資料類型長度是否可為空
ID 文章編號int 4 否
Topic 文章標題nvarchar 100 否
Author 作者nvarchar 100 是
Content 文章內容ntext 16 否
PostTime 發表時間datetime 8 否

其中PostTime 的預設值可以設定為(getutcdate())

SQL 語句是

Create TABLE [News_Articles] (
[ID] [int] IDENTITY (1, 1) NOT NULL ,
[Topic] [nvarchar] (100) COLLATE Chinese_PRC_CI_AS NOT NULL ,
[Author] [nvarchar] (100) COLLATE 中文_PRC_CI_AS NULL ,
[Content] [ntext] COLLATE Chinese_PRC_CI_AS NOT NULL ,
[PostTime] [datetime] NOT NULL CONSTRAINT [DF_News_Articles_PostTime] DEFAULT (getutcdate())
) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY]
GO

附2：News_Articles 專案原始碼說明：開啟專案檔案News_Articles.csproj 之前需要先設定虛擬路徑News_Articles，或在News_Articles.csproj.webinfo 中變更設定。要正常運作也必須安裝有SQL Server 並且安裝了文章資料庫News_Articles。專案原始碼的根目錄下有SQL 文字檔。