使用 Team Foundation 的用戶端物件模型，為不同的工作項目類型撰寫程式碼
當您為不同的 Team 專案中撰寫程式碼時，您可以執行以類似的用途不同工作項目類型的相同的函式。這些型別可能不同，因為它們是來自不同的流程範本，或是小組可能已經自訂它們對特定 Team 專案。例如，您可能會想要執行使用者劇本和要求的相同功能，都應該代表哪些客戶需求和值。而是工作項目類型的文字不同的程式碼，您可以推斷您的程式碼對這兩個工作。此外，一個小組可能已經自訂使用者劇本的工作項目類型定義，小組成員可以估計工作時數 (而非在劇本點。您可以避免複製您的工作以及藉由調整您的程式碼來處理預設和自訂的策略。
在本主題中，您可以執行工作項目類型的特定類型的工作尚未自訂的程式碼範例，您可以學習如何重構該程式碼支援特定型別的自訂。如需如何自訂工作項目類型的詳細資訊，請參閱 自訂 Team 專案和流程。
本主題內容
列印使用者劇本樹狀結構與評量的劇本點。
列印使用者劇本樹狀結構與在估計劇本點或基準工作
列印當做具有估計的需求工作項目的樹狀結構。
列印使用者劇本樹狀結構與評量的劇本點。
這個程式碼範例會列印所有使用者劇本樹狀結構中每一個 Team 專案的伺服器上並包含沒有子系的每個劇本的估計值。若要使用此範例，請建立主控台應用程式中，加入下列組件的參考，然後以下列程式碼取代 Program.cs (或 Module1.vb) 的內容。
using System;
using System.Text;
using System.Collections.ObjectModel;
using Microsoft.TeamFoundation.Client;
using Microsoft.TeamFoundation.Framework.Client;
using Microsoft.TeamFoundation.Framework.Common;
using Microsoft.TeamFoundation.WorkItemTracking.Client;
namespace Microsoft.TeamFoundation.SDK
{
class Program
{
static void Main(string[] args)
{
try
{
// Connect to Team Foundation Server. The form of the url is http://server:port/vpath.
// Server - the name of the server that is running the application tier for Team Foundation.
// port - the port that Team Foundation uses. The default port is 8080.
// vpath - the virtual path to the Team Foundation application. The default path is tfs.
TfsConfigurationServer configurationServer =
TfsConfigurationServerFactory.GetConfigurationServer(new Uri("https://Server:8080/tfs"));
// Get the catalog of team project collections
CatalogNode catalogNode = configurationServer.CatalogNode;
ReadOnlyCollection<CatalogNode> tpcNodes = catalogNode.QueryChildren(
new Guid[] { CatalogResourceTypes.ProjectCollection }, false, CatalogQueryOptions.None);
// Process each team project collection
foreach (CatalogNode tpcNode in tpcNodes)
{
// Use the InstanceId property to get the team project collection
Guid tpcId = new Guid(tpcNode.Resource.Properties["InstanceId"]);
TfsTeamProjectCollection tpc = configurationServer.GetTeamProjectCollection(tpcId);
// Get the work item store
WorkItemStore wiStore = tpc.GetService<WorkItemStore>();
// Query for the trees of active user stories in the team project collection
StringBuilder queryString = new StringBuilder("SELECT [System.Id] FROM WorkItemLinks WHERE ");
queryString.Append("([Source].[System.WorkItemType] = 'User Story' AND [Source].[System.State] = 'Active') AND ");
queryString.Append("([System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward') And ");
queryString.Append("([Target].[System.WorkItemType] = 'User Story' AND [Target].[System.State] = 'Active') ORDER BY [System.Id] mode(Recursive)");
Query wiQuery = new Query(wiStore, queryString.ToString());
WorkItemLinkInfo[] wiTrees = wiQuery.RunLinkQuery();
// Print the trees of user stories, with the estimated sizes of each leaf
PrintTrees(wiStore, wiTrees, " ", 0, 0);
}
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
}
// Each WorkItemLinkInfo structure in the collection contains the IDs of the linked work items.
// In this case, the sourceId is the ID of the user story that is on the parent side of the link, and
// the targetId is the ID of the user story that is on the child side of the link. The links
// are returned in depth-first order. This function recursively traverses the collection
// and the title of each user story. If the user story has no children, its estimation is also printed.
static int PrintTrees(WorkItemStore wiStore, WorkItemLinkInfo[] wiTrees, string prefix, int sourceId, int iThis)
{
int iNext = 0;
// Get the parent of this user story, if it has one
WorkItem source = null;
if (sourceId != 0)
{
source = wiStore.GetWorkItem(wiTrees[iThis].SourceId);
}
// Process the items in the list that have the same parent as this user story
while (iThis < wiTrees.Length && wiTrees[iThis].SourceId == sourceId)
{
// Get this user story
WorkItem target = wiStore.GetWorkItem(wiTrees[iThis].TargetId);
Console.Write(prefix);
Console.Write(target.Type.Name);
Console.Write(": ");
Console.Write(target.Fields["Title"].Value);
if (iThis < wiTrees.Length - 1)
{
if (wiTrees[iThis].TargetId == wiTrees[iThis + 1].SourceId)
{
// The next item is this user story's child. Process the children
Console.WriteLine();
iNext = PrintTrees(wiStore, wiTrees, prefix + " ", wiTrees[iThis + 1].SourceId, iThis + 1);
}
else
{
// The next item is not this user story's child.
Console.Write("; estimate = ");
Console.WriteLine(target.Fields["Story Points"].Value);
iNext = iThis + 1;
}
}
else
{
// This user story is the last one.
iNext = iThis + 1;
}
iThis = iNext;
}
return iNext;
}
}
}
Imports System
Imports System.Text
Imports System.Collections.ObjectModel
Imports Microsoft.TeamFoundation.Client
Imports Microsoft.TeamFoundation.Framework.Client
Imports Microsoft.TeamFoundation.Framework.Common
Imports Microsoft.TeamFoundation.WorkItemTracking.Client
Module Module1
Sub Main(ByVal sArgs() As String)
Try
' Connect to the Team Foundation Server. The form of the url is http://server:port/vpath.
' Server - the name of the server that is running the application tier for Team Foundation
' Port - the port that Team Foundation uses. The default port is 8080.
' Vpath - the virtual path to the Team Foundation application. The default is tfs.
Dim tfsUri As New Uri("https://Server:8080/tfs")
Dim configurationServer As TfsConfigurationServer
configurationServer = TfsConfigurationServerFactory.GetConfigurationServer(tfsUri)
' Get the catalog of team project collections
Dim catalogNode As CatalogNode
catalogNode = configurationServer.CatalogNode
Dim tpcNodes As ReadOnlyCollection(Of CatalogNode)
Dim gVar As Guid() = New Guid() {CatalogResourceTypes.ProjectCollection}
tpcNodes = catalogNode.QueryChildren(gVar, False, CatalogQueryOptions.None)
' Process each team project collection
For Each tpcNode In tpcNodes
Dim tpcGuid As Guid = New Guid(tpcNode.Resource.Properties("InstanceID"))
Dim tpc As New TfsTeamProjectCollection(tfsUri)
tpc = configurationServer.GetTeamProjectCollection(tpcGuid)
' Get the work item store
Dim wiStore As WorkItemStore
wiStore = tpc.GetService(Of WorkItemStore)()
' Query for the trees of active user stories in the team project collection
Dim queryString As New StringBuilder("SELECT [System.ID] FROM WorkItemLinks WHERE ")
queryString.Append("([Source].[System.WorkItemType] = 'User Story' AND [Source].[System.State] = 'Active') AND ")
queryString.Append("([System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward') And ")
queryString.Append("([Target].[System.WorkItemType] = 'User Story' AND [Target].[System.State] = 'Active') ORDER BY [System.Id] mode(Recursive)")
Dim wiQuery As New Query(wiStore, queryString.ToString())
Dim wiTrees() As WorkItemLinkInfo
wiTrees = wiQuery.RunLinkQuery()
' Print the trees of user stories with the estimated size of each leaf.
PrintTrees(wiStore, wiTrees, " ", 0, 0)
Next
Catch ex As Exception
Console.WriteLine(ex.Message)
End Try
End Sub
' Each WorkItemLinkInfo structure in the collection contains the IDs of the linked work items.
' In this case, the sourceId is the ID of the user story that is on the parent side of the link, and
' the targetId is the ID of the user story that is on the child side of the link. The links
' are returned in depth-first order. This function recursively traverses the collection
' and the title of each user story. If the user story has no children, its estimation is also printed.
Function PrintTrees(ByVal wiStore As WorkItemStore, ByVal wiTrees As WorkItemLinkInfo(), ByVal prefix As String, ByVal sourceId As Integer, ByVal iThis As Integer) As Integer
Dim iNext As Integer = 0
' Get the parent of this user story, if it has one
Dim source As WorkItem = Nothing
If sourceId <> 0 Then
source = wiStore.GetWorkItem(wiTrees(iThis).SourceId)
End If
' Process the items in the list that have the same parent as this user story
While (iThis < wiTrees.Length AndAlso wiTrees(iThis).SourceId = sourceId)
' Get this user story
Dim target As WorkItem
target = wiStore.GetWorkItem(wiTrees(iThis).TargetId)
Console.Write(prefix)
Console.Write(target.Type.Name)
Console.Write(": ")
Console.Write(target.Fields("Title").Value)
If iThis < (wiTrees.Length - 1) Then
If wiTrees(iThis).TargetId = wiTrees(iThis + 1).SourceId Then
' The next item is the user story's child.
Console.WriteLine()
iNext = PrintTrees(wiStore, wiTrees, prefix + " ", wiTrees(iThis + 1).SourceId, iThis + 1)
Else
' The next item is not the user story's child
Console.Write("; estimate = ")
Console.WriteLine(target.Fields("Story Points").Value)
iNext = iThis + 1
End If
Else
' This user story is the last one.
iNext = iThis + 1
End If
iThis = iNext
End While
Return iNext
End Function
End Module
列印使用者劇本樹狀結構與在估計劇本點或基準工作
這個範例修改 PrintTrees 方法決定每個工作項目類型是否使用劇本點欄位或基準工作欄位和列印從該欄位的估計值。若要使用此範例，您可以使用下列程式碼取代 PrintTrees 方法的程式碼行 Console.WriteLine(target.Fields["Story Points"].Value); 。
// Determine which estimation field is present
string fieldName = "Story Points";
if (target.Type.FieldDefinitions.TryGetByName(fieldName) == null)
{
fieldName = "Baseline Work";
}
Console.WriteLine(target.Fields[fieldName].Value);
Dim fieldName As String
fieldName = "Story Points"
If (target.Type.FieldDefinitions.TryGetByName(fieldName) Is Nothing) Then
fieldName = "Baseline Work"
End If
Console.WriteLine(target.Fields(fieldName).Value)
所有工作項目類型列印樹狀結構中的分類。
您可以經過分類會因相同或相似用途不同 Team 專案中工作項目的類型。您可以撰寫程式碼來執行在所屬的分類中的所有工作項目相同的函式。這個範例會列印任何類型的工作項目類型的估計值會在要求的分類，例如使用者劇本、需求和產品待處理項目。
若要使用此範例，請將下列程式碼取代與前一個範例的主函式。
static void Main(string[] args)
{
try
{
// Connect to Team Foundation Server. The form of the url is http://server:port/vpath.
// server - the name of the server that is running the application tier for Team Foundation.
// port - the port that Team Foundation uses. The default ort is 8080.
// vpath - the virtual path to the Team Foundation application. The default path is tfs.
TfsConfigurationServer configurationServer =
TfsConfigurationServerFactory.GetConfigurationServer(new Uri("https://server:8080/tfs"));
// Get the catalog of team project collections
CatalogNode catalogNode = configurationServer.CatalogNode;
ReadOnlyCollection<CatalogNode> tpcNodes = catalogNode.QueryChildren(
new Guid[] { CatalogResourceTypes.ProjectCollection }, false, CatalogQueryOptions.None);
// Process each team project collection
foreach (CatalogNode tpcNode in tpcNodes)
{
// Use the InstanceId property to get the team project collection
Guid tpcId = new Guid(tpcNode.Resource.Properties["InstanceId"]);
TfsTeamProjectCollection tpc = configurationServer.GetTeamProjectCollection(tpcId);
// Get the work item store
WorkItemStore wiStore = tpc.GetService<WorkItemStore>();
foreach (Project project in wiStore.Projects)
{
Console.Write("Project: ");
Console.WriteLine(project.Name);
// Get the type of work item to use
CategoryCollection categories = wiStore.Projects[project.Name].Categories;
string wiType = categories["Requirement Category"].DefaultWorkItemType.Name;
// Query for the trees of active user stories in the team project collection
StringBuilder queryString = new StringBuilder("SELECT [System.Id] FROM WorkItemLinks WHERE ");
queryString.Append("([Source].[System.WorkItemType] = '");
queryString.Append(wiType);
queryString.Append("' AND [Source].[System.TeamProject] = '");
queryString.Append(project.Name);
queryString.Append("') AND ");
queryString.Append("([System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward') And ");
queryString.Append("([Target].[System.WorkItemType] = 'User Story' AND ");
queryString.Append("[Target].[System.State] = 'Active') ORDER BY [System.Id] mode(Recursive)");
Query wiQuery = new Query(wiStore, queryString.ToString());
WorkItemLinkInfo[] wiTrees = wiQuery.RunLinkQuery();
// Print the trees of user stories and requirements, with the estimated size of each leaf
PrintTrees(wiStore, wiTrees, " ", 0, 0);
}
}
}
catch (Exception e)
{
Console.WriteLine(e.Message);
}
}
Sub Main(ByVal sArgs() As String)
Try
' Connect to the Team Foundation Server. The form of the url is http://server:port/vpath.
' Server - the name of the server that is running the application tier for Team Foundation
' Port - the port that Team Foundation uses. The default port is 8080.
' Vpath - the virtual path to the Team Foundation application. The default is tfs.
Dim tfsUri As New Uri("https://server:8080/tfs")
Dim configurationServer As TfsConfigurationServer
configurationServer = TfsConfigurationServerFactory.GetConfigurationServer(tfsUri)
' Get the catalog of team project collections
Dim catalogNode As CatalogNode
catalogNode = configurationServer.CatalogNode
Dim tpcNodes As ReadOnlyCollection(Of CatalogNode)
Dim gVar As Guid() = New Guid() {CatalogResourceTypes.ProjectCollection}
tpcNodes = catalogNode.QueryChildren(gVar, False, CatalogQueryOptions.None)
' Process each team project collection
For Each tpcNode In tpcNodes
Dim tpcGuid As Guid = New Guid(tpcNode.Resource.Properties("InstanceID"))
Dim tpc As New TfsTeamProjectCollection(tfsUri)
tpc = configurationServer.GetTeamProjectCollection(tpcGuid)
' Get the work item store
Dim wiStore As WorkItemStore
wiStore = tpc.GetService(Of WorkItemStore)()
' Query for the trees of active user stories in the team project collection
Dim project As Project
For Each project In wiStore.Projects
Console.Write("Project: ")
Console.WriteLine(project.Name)
' Get the type of work item to use
Dim categories As CategoryCollection
categories = wiStore.Projects(project.Name).Categories
Dim wiType As String
wiType = categories("Requirement Category").DefaultWorkItemType.Name
' Query for the trees of active user stories in the team project collection
Dim queryString As New StringBuilder("SELECT [System.Id] FROM WorkItemLinks WHERE ")
queryString.Append("([Source].[System.WorkItemType] = '")
queryString.Append(wiType)
queryString.Append("' AND [Source].[System.TeamProject] = '")
queryString.Append(project.Name)
queryString.Append("') AND ")
queryString.Append("([System.Links.LinkType] = 'System.LinkTypes.Hierarchy-Forward') And ")
queryString.Append("([Target].[System.WorkItemType] = 'User Story' AND [Target].[System.State] = 'Active') ORDER BY [System.Id] mode(Recursive)")
Dim wiQuery As New Query(wiStore, queryString.ToString())
Dim wiTrees() As WorkItemLinkInfo
wiTrees = wiQuery.RunLinkQuery()
' Print the trees of user stories with the estimated size of each leaf.
PrintTrees(wiStore, wiTrees, " ", 0, 0)
Next
Next
Catch ex As Exception
Console.WriteLine(ex.Message)
End Try
End Sub