TaskVision 解决方案概述：设计与实现

TaskVision 解决方案概述：设计与实现

	概述
	解决方案体系结构
	学习心得
	获得更多信息

概述

什么是 TaskVision 解决方案？

TaskVision 入门

TaskVision Live Client v1.0 MSI 安装

TaskVision Server v1.1 MSI 安装

<appSettings>
<!-- User application and configured property settings go here.-->
<!-- Example: <add key="settingName" value="settingValue"/> -->
<add key="AppUpdater1.UpdateUrl" value="http://localhost/taskvisionupdates/updateversion.xml"/>
<add key="TaskVision.AuthWS.AuthService" value="http://localhost/taskvisionws/authservice.asmx"/>
<add key="TaskVision.DataWS.DataService" value="http://localhost/taskvisionws/dataservice.asmx"/>
</appSettings>
</configuration>

TaskVision Source Code v1.1 MSI 安装

解决方案体系结构

数据库

数据库架构

存储过程

XML Web 服务

身份验证 XML Web 服务

'create the ticket
Dim ticket As New FormsAuthenticationTicket(userID, False, 1)
Dim encryptedTicket As String = FormsAuthentication.Encrypt(ticket)

'get the ticket timeout in minutes
Dim configurationAppSettings As AppSettingsReader = New AppSettingsReader()
Dim timeout As Integer = _
CInt(configurationAppSettings.GetValue("AuthenticationTicket.Timeout", _
GetType(Integer)))

'cache the ticket
Context.Cache.Insert(encryptedTicket, userID, Nothing, _
DateTime.Now.AddMinutes(timeout), TimeSpan.Zero)

数据 XML Web 服务

Private Function IsTicketValid(ByVal ticket As String, ByVal IsAdminCall _
As Boolean) As Boolean
If ticket Is Nothing OrElse Context.Cache(ticket) Is Nothing Then
'not authenticated
Return False
Else
'check the user authorization
Dim userID As Integer = _
CInt(FormsAuthentication.Decrypt(ticket).Name)

Dim ds As DataSet
Try
ds = SqlHelper.ExecuteDataSet(dbConn, "GetUserInfo", userID)
Finally
dbConn.Close()
End Try

Dim userInfo As New UserInformation()
With ds.Tables(0).Rows(0)
userInfo.IsAdministrator = CBool(.Item("IsAdministrator"))
userInfo.IsAccountLocked = CBool(.Item("IsAccountLocked"))
End With

If userInfo.IsAccountLocked Then
Return False
Else
'check admin status (for admin required calls)
If IsAdminCall And Not userInfo.IsAdministrator Then
Return False
End If

Return True
End If
End If
End Function
_
Public Function GetTasks(ByVal ticket As String, ByVal projectID _
As Integer) As DataSetTasks

'if the ticket is not valid, return
If Not IsTicketValid(ticket) Then Return Nothing

Dim ds As New DataSetTasks()
daTasks.SelectCommand.Parameters("@ProjectID").Value = projectID
daTasks.Fill(ds, "Tasks")
Return ds
End Function

Windows 窗体智能客户端

用户界面窗体

数据层组件

Public Function GetProjects() As DataLayerResult
'this is the ds that gets returned from the ws
Dim ds As DataSetProjects
Try
'request the ds and pass the ticket
ds = m_WsData.GetProjects(m_Ticket)

'all TaskVision web services return nothing
'(or -1 for integer requests) to indicate an expired ticket
If ds Is Nothing Then
'get a new ticket and try the call again
Dim ticketResult As DataLayerResult = GetAuthorizationTicket()
'if the ticket failed return its error as our own
If ticketResult <> DataLayerResult.Success Then
Return ticketResult
End If

'try the call again
ds = m_WsData.GetProjects(m_Ticket)

'this next block should never happen.
'it means the ws ticket expired too quickly
If ds Is Nothing Then
Return DataLayerResult.AuthenticationFailure
End If
End If
Catch ex As Exception
Return HandleException(ex)
End Try

DsProjects.Clear()
DsProjects.Merge(ds)
Return DataLayerResult.Success
End Function
Public Enum DataLayerResult
None = 0
Success = 1
ServiceFailure = 2
UnknownFailure = 3
ConnectionFailure = 4
AuthenticationFailure = 5
End Enum

Public Function BeginGetProjectHistory(ByVal projectID As Integer) As IAsyncResult
Try
'note: there is an assumption here that our ticket is always valid
'because this method is called immediately after a project or task request.

'start an async call for the
Return m_WsData.BeginGetProjectHistory(m_Ticket, projectID, _
Nothing, New Object() {projectID})

Catch ex As Exception
LogError.Write(ex.Message & vbNewLine & ex.StackTrace)
Return Nothing
End Try
End Function

Public Function EndGetProjectHistory(ByVal ar As IAsyncResult) As DataLayerResult
Dim ds As DataSetProjectHistory

Try
'grab the new DataSet
ds = m_WsData.EndGetProjectHistory(ar)

If ds Is Nothing Then
Return DataLayerResult.AuthenticationFailure
End If
Catch ex As Exception
Return HandleException(ex)
End Try

DsProjectHistory.ProjectHistory.Clear()
DsProjectHistory.Merge(ds)
Return DataLayerResult.Success
End Function

数据冲突

CREATE PROCEDURE [UpdateTask]
(
@TaskID int,
@ProjectID int,
@ModifiedBy int,
@AssignedTo int,
@TaskSummary varchar(70),
@TaskDescription varchar(500),
@PriorityID int,
@StatusID int,
@Progress int,
@IsDeleted bit,
@DateDue datetime,
@DateModified datetime,
@DateCreated datetime,
@Original_ProjectID int,
@Original_ModifiedBy int,
@Original_AssignedTo int,
@Original_TaskSummary varchar(70),
@Original_TaskDescription varchar(500),
@Original_PriorityID int,
@Original_StatusID int,
@Original_Progress int,
@Original_IsDeleted bit,
@Original_DateDue datetime,
@Original_DateModified datetime,
@Original_DateCreated datetime
)
AS
SET NOCOUNT OFF;
--note we are using convert to varchar on the date comparison so that the pocket pc app can use this sproc the pocket pc app stores offline data which only supports a 4 byte datetime.

UPDATE Tasks
SET ProjectID = @ProjectID, ModifiedBy = @ModifiedBy, AssignedTo = @AssignedTo, TaskSummary = @TaskSummary, TaskDescription = @TaskDescription, PriorityID = @PriorityID, StatusID = @StatusID, Progress = @Progress, IsDeleted = @IsDeleted, DateDue = @DateDue, DateModified = @DateModified
WHERE (TaskID = @TaskID) AND (ProjectID = @Original_ProjectID) AND (ModifiedBy = @Original_ModifiedBy) AND (AssignedTo = @Original_AssignedTo) AND (TaskSummary = @Original_TaskSummary) AND (TaskDescription = @Original_TaskDescription) AND (ProjectID = @Original_ProjectID) AND (StatusID = @Original_StatusID) AND (Progress = @Original_Progress) AND (IsDeleted = @Original_IsDeleted) AND (convert(varchar(20), DateDue) = convert(varchar(20), @Original_DateDue)) AND (convert(varchar(20), DateModified) = convert(varchar(20), @Original_DateModified)) AND (convert(varchar(20), DateCreated) = convert(varchar(20), @Original_DateCreated)) AND (PriorityID = @Original_PriorityID);
SELECT TaskID, ProjectID, ModifiedBy, AssignedTo, TaskSummary, TaskDescription, PriorityID, StatusID, Progress, IsDeleted, DateDue, DateModified, DateCreated FROM Tasks WHERE (TaskID = @TaskID)
GO

'we're doing a loop on the update function and breaking out on a successful update
'or returning prematurely from a data collision, this allows us to handle
'missing data without returning to the client.
Do
Try
'try to update the db
daTasks.Update(dsTasks, "Tasks")
Exit Do 'this is the most common path
Catch dbEx As DBConcurrencyException
'we're here because either the row was changed by someone else
'or deleted by the dba, let's try get the updated row
Dim ds As New DataSet()
Dim cmd As New SqlCommand("GetOneTask", dbConn)
cmd.CommandType = CommandType.StoredProcedure

'get the updated row
Dim da As New SqlDataAdapter(cmd)
da.SelectCommand.Parameters.Add("@TaskID", dbEx.Row.Item("TaskID"))
da.Fill(ds)

'if the row still exists
If ds.Tables(0).Rows.Count > 0 Then
Dim proposedRow As DataRow = dbEx.Row.Table.NewRow()
Dim databaseRow As DataRow = ds.Tables(0).Rows(0)

'copy the attempted changes
proposedRow.ItemArray = dbEx.Row.ItemArray

'set the row with what's in the database and then re-apply
'the proposed changes
With dbEx.Row
.Table.Columns("TaskID").ReadOnly = False
.ItemArray = databaseRow.ItemArray
.AcceptChanges()
.ItemArray = proposedRow.ItemArray
.Table.Columns("TaskID").ReadOnly = True
End With

'note: because this row triggered an ADO.NET exception, the row
'was tagged with a rowerror property which we'll leave for the
'client app
Return dsTasks
Else
'row was deleted from underneath user, deletion always wins
dbEx.Row.Delete()
dbEx.Row.AcceptChanges()
End If
End Try
Loop

脱机 — 联机数据模型

Try
'check for the offline files
If File.Exists(m_MyDocumentsPath & c_OfflineTasksFile) AndAlso _
File.Exists(m_MyDocumentsPath & c_OfflineProjectsFile) AndAlso _
File.Exists(m_MyDocumentsPath & c_OfflineLookUpTablesFile) Then
Try
'engage offline mode
ChangeOnlineStatus(False)

'try to read the offline data
m_DataLayer.DsProjects.ReadXml(m_MyDocumentsPath & _
c_OfflineProjectsFile, XmlReadMode.ReadSchema)

m_DataLayer.DsTasks.ReadXml(m_MyDocumentsPath & _
c_OfflineTasksFile, XmlReadMode.ReadSchema)

m_DataLayer.DsLookupTables.ReadXml(m_MyDocumentsPath & _
c_OfflineLookUpTablesFile, XmlReadMode.ReadSchema)

'workaround: scheme doesn't include autoincrement
m_DataLayer.DsTasks.Tasks.Columns("TaskID").AutoIncrement = True

'we now have the exact data when the user went offline
m_DataLayer.DsTasks.AcceptChanges()

'if we have any changes then read them in
If File.Exists(m_MyDocumentsPath & c_OfflineTaskChangesFile) Then
m_DataLayer.DsTasks.ReadXml(m_MyDocumentsPath & _
c_OfflineTaskChangesFile, XmlReadMode.DiffGram)
End If

'because our project could have come from the registry let's verify it
'otherwise choose the first project id
If m_DataLayer.DsProjects.Projects.Rows.Find(m_ProjectID) _
Is Nothing Then

m_ProjectID = _
CType(m_DataLayer.DsProjects.Projects.Rows(0)("ProjectID"), _
Integer)

End If
Catch ex As Exception
LogError.Write(ex.Message & vbNewLine & ex.StackTrace)
'we don't care what the error is, lets dump it and move on
Dim mbResult As DialogResult = _
MessageBox.Show(m_ResourceManager.GetString( _
"MessageBox.Show(There_was_an_error_reading_theoffline_files)") _
& vbNewLine & vbNewLine & _
m_ResourceManager.GetString("Do_you_want_to_go_online"), _
"", MessageBoxButtons.YesNo, MessageBoxIcon.Error, _
MessageBoxDefaultButton.Button1, _
MessageBoxOptions.DefaultDesktopOnly)

Me.Refresh()
If mbResult = DialogResult.Yes Then
'user choose to go online
ChangeOnlineStatus(True)

DeleteOfflineFiles()
m_DataLayer.DsProjects.Clear()
m_DataLayer.DsTasks.Clear()
m_DataLayer.DsLookupTables.Clear()
Else
Throw New ExitException()
End If
End Try
End If

.NET Updater 组件

DataGrid 列样式

Protected Overloads Overrides Sub Edit(ByVal source As _
System.Windows.Forms.CurrencyManager, ByVal rowNum As Integer, _
ByVal bounds As System.Drawing.Rectangle, ByVal isReadOnly As _
Boolean, ByVal instantText As String, ByVal cellIsVisible As Boolean)

'Do Nothing
End Sub

Protected Overloads Overrides Sub Paint(ByVal g As System.Drawing.Graphics, _
ByVal bounds As System.Drawing.Rectangle, ByVal source As _
System.Windows.Forms.CurrencyManager, ByVal rowNum As Integer, _
ByVal backBrush As System.Drawing.Brush, ByVal foreBrush As _
System.Drawing.Brush, ByVal alignToRight As Boolean)
Dim bVal As Object = GetColumnValueAtRow(source, rowNum)
Dim imageToDraw As Image

'we're caching the image in a hashtable
If m_HtImages.ContainsKey(bVal) Then
imageToDraw = CType(m_HtImages(bVal), System.Drawing.Image)
Else
'get the image from disk and cache it
Try
imageToDraw = Image.FromFile(c_PriorityImagesPath & _
CType(bVal, String) & ".gif")
m_HtImages.Add(bVal, imageToDraw)
Catch
'display error msg
Return
End Try
End If

'if the current row is this row, draw the selection back color
If Me.DataGridTableStyle.DataGrid.CurrentRowIndex = rowNum Then
g.FillRectangle(New    SolidBrush(Me.DataGridTableStyle.SelectionBackColor), _
bounds)
Else
g.FillRectangle(backBrush, bounds)
End If

'now draw the image
g.DrawImage(imageToDraw, New Point(bounds.X, bounds.Y))
End Sub

Protected Overloads Overrides Sub Paint(ByVal g As System.Drawing.Graphics, _
ByVal bounds As System.Drawing.Rectangle, ByVal source As _
System.Windows.Forms.CurrencyManager, ByVal rowNum As Integer, _
ByVal backBrush As System.Drawing.Brush, ByVal foreBrush As _
System.Drawing.Brush, ByVal alignToRight As Boolean)

Dim progressVal As Integer = CType(GetColumnValueAtRow(source, rowNum), Integer)
Dim percentage As Single = CType((progressVal / 100), Single)

'if the current row is this row, draw the selection back color
If Me.DataGridTableStyle.DataGrid.CurrentRowIndex = rowNum Then
g.FillRectangle(New SolidBrush(Me.DataGridTableStyle.SelectionBackColor), _
bounds)
Else
g.FillRectangle(backBrush, bounds)
End If

If percentage > 0.0 Then
'draw the progress bar and the text
g.FillRectangle(New SolidBrush(Color.FromArgb(163, 189, 242)), _
bounds.X + 2, bounds.Y + 2, Convert.ToInt32((percentage * _
bounds.Width - 4)), bounds.Height - 4)

g.DrawString(progressVal.ToString() & "%", _
Me.DataGridTableStyle.DataGrid.Font, foreBrush, bounds.X + 6, _
bounds.Y + 2)
Else
'draw the text
If Me.DataGridTableStyle.DataGrid.CurrentRowIndex = rowNum Then
g.DrawString(progressVal.ToString() & "%", _
Me.DataGridTableStyle.DataGrid.Font, New _
SolidBrush(Me.DataGridTableStyle.SelectionForeColor), _
bounds.X + 6, bounds.Y + 2)
Else
g.DrawString(progressVal.ToString() & "%", _
Me.DataGridTableStyle.DataGrid.Font, foreBrush, _
bounds.X + 6, bounds.Y + 2)
End If
End If
End Sub

打印和打印预览

Dim pDialogResult As DialogResult = PrintDialog1.ShowDialog()

If pDialogResult = DialogResult.OK Then PrintDocument1.Print()

Private Sub DrawPageHeader(ByVal g As Graphics)
'create the header rectangle
Dim headerBounds As New RectangleF(c_LeftMargin, c_TopMargin, _
m_PageWidthMinusMargins, m_DataGrid.HeaderFont.SizeInPoints + _
c_VerticalCellLeeway)

'draw the header rectangle
g.FillRectangle(New SolidBrush(m_DataGrid.HeaderBackColor), headerBounds)

Dim xPosition As Single = c_LeftMargin + 12 ' +12 for some padding

'use this format when drawing later
Dim cellFormat As New StringFormat()
cellFormat.Trimming = StringTrimming.Word
cellFormat.FormatFlags = StringFormatFlags.NoWrap Or _
StringFormatFlags.LineLimit

'find the column names from the TableStyle
Dim cs As DataGridColumnStyle
For Each cs In m_DataGrid.TableStyles(0).GridColumnStyles
If cs.Width > 0 Then
'temp width to draw this column
Dim columnWidth As Integer = cs.Width

'scale the summary column width
'note: just a quick way to fit the text to the page width
'this is not the best way to do this but it handles the most
'common ui path for this demo app
If cs.MappingName = "TaskSummary" And m_IsTooWide Then
columnWidth -= m_AdjColumnBy
ElseIf cs.MappingName = "TaskSummary" Then
columnWidth += m_AdjColumnBy
End If

'create a layout rectangle to draw within.
Dim cellBounds As New RectangleF(xPosition, c_TopMargin, columnWidth, _
m_DataGrid.HeaderFont.SizeInPoints + c_VerticalCellLeeway)

'draw the column name
g.DrawString(cs.HeaderText, m_DataGrid.HeaderFont, New SolidBrush(m_DataGrid.HeaderForeColor), cellBounds, cellFormat)

'adjust the next X Pos
xPosition += columnWidth
End If
Next
End Sub

Expander 控件和 Expander 列表控件

Public Sub ControlExpanded(ByVal x As XPander)
Dim ctl As Control

Dim enumerator As IDictionaryEnumerator = m_ControlList.GetEnumerator()
While enumerator.MoveNext
ctl = CType(enumerator.Value, Control)
If ctl.Top > x.Top Then
ctl.Top += x.ExpandedHeight - x.CaptionHeight
End If
End While
End Sub

Protected Overrides Sub OnPaint(ByVal e As PaintEventArgs)
Dim rc As New Rectangle(0, 0, Me.Width, CaptionHeight)
Dim b As New LinearGradientBrush(rc, Color.White, CaptionColor, _
LinearGradientMode.Horizontal)

'now draw the caption area at the top
e.Graphics.FillRectangle(b, rc)

Custom Chart 控件

chartPriority.DataTable = m_DataLayer.DsTasks.Tasks
chartPriority.DataMember = "PriorityText"

Progress Chart 控件

chartProgress.DataTable = m_DataLayer.DsTasks.Tasks
chartProgress.DataMember = "Progress"

History Panel 控件

'create a linklabel
Dim newLinkLabel As New LinkLabel()
newLinkLabel.Text = datePrefix & CType(row.Item(m_DisplayMember), String)
newLinkLabel.Location = New System.Drawing.Point(c_LinkLabelStartingX, _
(c_LinkLabelStartingY + (numLinks * c_LinkLabelHeight)))
newLinkLabel.Size = New System.Drawing.Size((Me.Width - _
(c_LinkLabelStartingX * 2)), c_LinkLabelHeight)
newLinkLabel.Name = "LinkLabel" & numLinks
newLinkLabel.Tag = (numLinks)
newLinkLabel.TabStop = True
newLinkLabel.FlatStyle = FlatStyle.System

'add the link label
Me.Controls.Add(newLinkLabel)
AddHandler newLinkLabel.Click, AddressOf LinkLabel_Click

'increment the number of matching links
numLinks += 1

Private Sub LinkLabel_Click(ByVal sender As Object, ByVal e As _
System.EventArgs)

're-raise the click event with our own parameters
Dim link As LinkLabel = CType(sender, LinkLabel)
RaiseEvent HistoryLinkClicked(m_SelectedTaskID, _
CType(link.Tag, Integer))
End Sub

DataProtection 类

'set the registry key value with the encrypted text
Dim regKey As RegistryKey = Registry.CurrentUser.CreateSubKey(c_RegistryKey)
regKey.SetValue("Password", _
DataProtection.ProtectData(txtPassword.Text, "TaskVisionPassword"))

'set the string value to decrypted registry key text
Dim password As String = String.Empty
password = DataProtection.UnprotectData(CType(regKey.GetValue("Password"), _
String))

支持的功能

•	本地化支持 — 本地化是一个将应用程序的资源翻译为该应用程序将要支持的各个国家/地区文化（即语言和历法差异）的本地化版本的过程。.NET Framework 主要使用了资源管理器的概念、资源文件和附属程序集来提供应用程序本地化的体系结构。Visual Studio .NET 通过在 Windows 窗体设计器中设置若干属性，简化了创建这些资源文件和程序集的过程。TaskVision 版本 1.1 实现了德语的本地化，并包含一个附属程序集，每种本地化形式都可以从该程序提取资源和属性值。简而言之，每种形式都有一个默认的资源文件，其中包含适用于默认文化的属性和图像。此外，每种形式都有一个“<formname>.de.resx”文件，该文件包含适用于德国文化的属性和图像。这些文件通常由 Visual Studio .NET 维护，并且仅存储特定于各个形式的数据。而且，如果开发人员要存储自定义本地化字符串（例如，自定义的异常消息），就需要创建附加的资源文件。TaskVision 有两个这样的文件，它们是“localize.resx”和“localize.de.resx”，用于存储自定义字符串。有关本地化文件的详细信息，请参阅 MSDN 上的 Introduction to Resources and Localization。
•	COM Interop — 与 COM 的互操作性，即 COM interop，使您能够使用现有的 COM 对象，并按照自己的节奏转换到 .NET 平台。TaskVision 演示了 COM Interop，方法是访问 Excel 10.0 类型库，然后实际上使 MS Excel 自动创建一个电子表格并使用 TaskVision 数据填充该表格。使用 COM interop 时，有两方面的事项需要注意。首先，必须在开发人员的计算机上安装软件（例如，本例中的 Excel）才可以引用 COM 对象。其次，开发人员应当预期到他们的软件的终端用户可能没有安装该软件（或必要的 COM 对象）的情况。有关 COM Interop 的详细信息，请参阅 MSDN 上的 Introduction to COM Interop。
•	辅助功能支持 — 为了演示 Visual Studio.NET 中支持的一种主要辅助功能，我们浏览并设置了所有 UI 控件的 AccessibleDescription 和 AccessibleName 属性。这些属性在诸如 Microsoft Narrator 等辅助功能应用程序（能够在运行时访问 UI 控件并在用户在应用程序中导航时准确地为用户读出说明）中扮演着重要角色。
•	动态属性 — 动态属性使您能够配置自己的应用程序，以便将其中一些属性值或全部属性值存储到一个外部配置文件中，而不是存储到已编译的代码中。通过向管理员提供对可能需要在未来进行更改的属性进行更新的方法，可以降低在部署应用程序后对应用程序进行维护的成本。例如，假定您要生成一个在开发过程中使用测试数据库的应用程序，并且，您需要在部署该应用程序时将其切换为产品数据库。如果将属性值存储到应用程序内部，您将需要在部署之前手动更改所有的数据库设置，然后重新编译源代码。如果在外部存储这些值，您只需在外部 XML 文件中进行一处更改，应用程序在下一次运行时即会加载新的值。TaskVision 演示了动态属性：它将 Updater Component Update URL 以及身份验证和数据 Web 服务这两者的 URL 存储到 TaskVision.exe.config 文件中。
•	Windows XP 主题 — Windows XP 中包含新版本的 Shell Common Controls 库（COMCTL32.DLL 版本 6.0）。该库中包含新的经过改进的彩色控件，例如，按钮和选项卡（请参考下面的图像）。要使用新版的公共控件，应用程序必须通过提供应用程序清单显式请求新的版本。该应用程序清单可以作为一个单独的文件或附加到可执行文件的资源来提供给 Windows XP。作为单独的文件提供时，该清单文件必须位于与可执行文件相同的目录中，并且必须具有与可执行文件相同的名称，名称后跟“.manifest”。例如，TaskVision.exe 的清单文件应当是 TaskVision.exe.manifest。除提供清单外，许多控件还要求将 FlatStyle 属性设置为 System，以便使用公共控件。 图 18 不带清单文件的应用程序 图 19 带有清单文件的应用程序

学习心得

数据层组件

XML Web 服务安全性

获得更多信息