Как трассировать процесс синхронизации
В данном разделе показано, как использовать инфраструктуру трассировки и класс трассировки в службах Sync Framework. В примерах этого раздела обсуждаются следующие типы и события платформы Sync Framework.
Сведения о запуске образца кода см. в подразделе «Образцы приложений в разделах инструкций» раздела Программирование распространенных задач синхронизации клиента и сервера.
Основные сведения о трассировке в службах Synchronization Services
Трассировка предусматривает регистрацию операций, данных и метаданных приложений, а также передачу этих сведений в прослушиватель. Прослушиватель часто записывает сведения о трассировке в файл, но может обрабатывать их и другими способами. В службах Sync Framework предусмотрена трассировка для клиентских и служб синхронизации сервера. В распределенных приложениях трассировка может быть очень важна, так как она позволяет устранять неполадки, которые в противном случае было бы трудно обнаружить.
В службах Sync Framework средства трассировки состоят из следующих компонентов.
Инфраструктура трассировки, основанная на реализации трассировки .NET Framework, в частности на классе TraceListener. Трассировке подвергаются наиболее важные операции поставщиков клиента и сервера, а ключевые метаданные передаются в один или несколько прослушивателей.
Объект SyncTracer. Это позволяет определять включенный уровень трассировки, а также записывать сообщения в выходные данные трассировки на основе событий в приложениях.
Кроме компонентов трассировки, которые предоставляют службы Sync Framework, устранение неисправностей обычно включает другие средства, например отладчик или Приложение SQL Server Profiler. Например, выходные данные трассировки могут включать сведения о базе данных SQL Server, а для получения дополнительной информации об операциях с базой данных, выполняемых службой синхронизации сервера, можно использовать Приложение SQL Server Profiler.
Использование инфраструктуры трассировки
По умолчанию для приложений служб Sync Framework трассировка отключена. Чтобы настроить прослушиватель трассировок, измените файл app.config в соответствии с приложением. Дополнительные сведения об этом файле см. в документации по Visual Studio. В этом файле можно добавить и удалить прослушиватель, установить его тип и связанные параметры или очистить файл от всех ранее установленных приложением прослушивателей. Дополнительные сведения о трассировке см. в документации по .NET Framework. Файл конфигурации должен выглядеть примерно так:
<configuration>
<system.diagnostics>
<switches>
<!-- 0-off, 1-error, 2-warn, 3-info, 4-verbose. -->
<add name="SyncTracer" value="3" />
</switches>
<trace autoflush="true">
<listeners>
<add name="TestListener" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\TraceSample.txt"/>
</listeners>
</trace>
</system.diagnostics>
</configuration>
Следующие XML-узлы включаются в образец кода.
Прослушиватель типа
System.Diagnostics.TextWriterTraceListener(TextWriterTraceListener) с путем кc:\TraceSample.txt.Переключатель с именем
SyncTracer. Он имеет значение3. В следующей таблице показаны все значения и их связь с выводом трассировки.Значение переключателя Уровень трассировки Выходные данные 0offНе направлять сообщения в прослушиватели трассировки.
1errorНаправлять в прослушиватели трассировки только сообщения об ошибках.
2warningНаправлять в прослушиватели трассировки сообщения об ошибках и предупреждения.
3infoНаправлять в прослушиватели трассировки информационные сообщения, сообщения об ошибках и предупреждения.
4verboseНаправлять все сообщения в прослушиватели трассировки.
Трассировка создает некоторую дополнительную нагрузку. Таким образом, следует учитывать, что применение трассировки может повлиять на то, соблюдаются ли требования по производительности приложения. В большинстве случаев параметры
infoиverboseдоступны только во время разработки и устранения неисправностей приложения.
В следующем файле конфигурации показан пример устройства.
<configuration>
<traceSettings>
<add key ="FileLocation" value="TraceSample.txt"/>
<add key ="LogLevel" value="4"/>
</traceSettings>
</configuration>
Файлу необходимо присвоить имя trace.config.txt и сохранить в каталоге приложений на устройстве. При включении файла в решение Visual Studio его можно будет развернуть вместе с приложением.
Следующий сегмент файла взят из трассировки, настроенной на использование значения SyncTracer, равного 3. Каждая строка начинается с выходных данных определенного типа. В данном случае выходными данными являются INFO. В случае возникновения ошибки соответствующие строки будут начинаться с ERROR.
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, соединение с сервером с помощью строки: Data Source=localhost;Initial Catalog=SyncSamplesDb;Integrated Security=True
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, ----- Server Enumerating Changes to Client for Group "Customer" -----
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, идентификатор клиента: bc5610f6-bf9c-4ccd-8599-839e54e953e2
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, сопоставленный идентификатор инициатора: 0
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:042,
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:042, ----- Enumerating Inserts for Table Customer -----
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:058, перечислено изменений: 5
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:058, --- End Enumerating Inserts for Table Customer ---
Использование объекта SyncTracer
Объект SyncTracer позволяет записывать данные трассировки приложения в файл трассировки. Это позволяет получить контекстные сведения о работе приложения в любое конкретное время. Этот объект позволяет выполнить следующие задачи.
Определить, какой уровень трассировки включен, с помощью следующих методов.
Запись сообщений в выходные данные трассировки в соответствии с событиями приложения с помощью следующих методов, а также других методов, являющихся перегруженными версиями каждого из этих методов:
Например, для вывода информационного сообщения можно использовать следующий код.
SyncTracer.Info("Informational message")Если включен уровень Info, сообщение будет записано в выходные данные. В противном случае оно пропускается.
Также можно формировать более сложные сообщения, подобные следующему. Указанные цифры устанавливают уровень отступа в выходном файле.
SyncTracer.Verbose("Processing table t1")SyncTracer.Verbose(1, "Applying Deletes")SyncTracer.Verbose(2, "{0} rows deleted", numDeleted)SyncTracer.Verbose(1, "Applying Inserts")SyncTracer.Verbose(2, "{0} rows inserted", numInserted)Выходные данные выглядят следующим образом.
Processing table t1Applying Deletes7 Rows DeletedApplying Inserts9 Rows inserted
Следующий образец кода записывает в консоль данные о том, какие уровни трассировки включены. Файл конфигурации указывает значение 3 для переключателя SyncTracer. Это соответствует Info. Таким образом, Error, Warning, Info возвращают значение типа True, а Verbose возвращает значение типа False.
Console.WriteLine("** Tracing Levels Enabled for this Application **");
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString());
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString());
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString());
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString());
Console.WriteLine("** Tracing Levels Enabled for this Application **")
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString())
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString())
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString())
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString())
В следующем образце кода показано, как записывать отформатированные предупреждения о конфликтах данных в выходные данные трассировки. Дополнительные сведения о конфликтах см. в разделе Как обрабатывать конфликты и ошибки в данных. Подробная трассировка предусматривает получение сведений о конфликтах. В данном приложении подробная трассировка отключена, а вместо этого для выработки предупреждений о конфликтах применяются флаги приложения.
if (SyncTracer.IsVerboseEnabled() == false && e.Conflict.ConflictType != ConflictType.ErrorsOccurred)
{
DataTable conflictingServerChange = e.Conflict.ServerChange;
DataTable conflictingClientChange = e.Conflict.ClientChange;
int serverColumnCount = conflictingServerChange.Columns.Count;
int clientColumnCount = conflictingClientChange.Columns.Count;
StringBuilder clientRowAsString = new StringBuilder();
StringBuilder serverRowAsString = new StringBuilder();
for (int i = 0; i < clientColumnCount; i++)
{
clientRowAsString.Append(conflictingClientChange.Rows[0][i] + " | ");
}
for (int i = 0; i < serverColumnCount; i++)
{
serverRowAsString.Append(conflictingServerChange.Rows[0][i] + " | ");
}
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId);
SyncTracer.Warning(2, "** Client change **");
SyncTracer.Warning(2, clientRowAsString.ToString());
SyncTracer.Warning(2, "** Server change **");
SyncTracer.Warning(2, serverRowAsString.ToString());
}
If SyncTracer.IsVerboseEnabled() = False AndAlso e.Conflict.ConflictType <> ConflictType.ErrorsOccurred Then
Dim conflictingServerChange As DataTable = e.Conflict.ServerChange
Dim conflictingClientChange As DataTable = e.Conflict.ClientChange
Dim serverColumnCount As Integer = conflictingServerChange.Columns.Count
Dim clientColumnCount As Integer = conflictingClientChange.Columns.Count
Dim clientRowAsString As New StringBuilder()
Dim serverRowAsString As New StringBuilder()
Dim i As Integer
For i = 1 To clientColumnCount - 1
clientRowAsString.Append(conflictingClientChange.Rows(0)(i).ToString() & " | ")
Next i
For i = 1 To serverColumnCount - 1
serverRowAsString.Append(conflictingServerChange.Rows(0)(i).ToString() & " | ")
Next i
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId)
SyncTracer.Warning(2, "** Client change **")
SyncTracer.Warning(2, clientRowAsString.ToString())
SyncTracer.Warning(2, "** Server change **")
SyncTracer.Warning(2, serverRowAsString.ToString())
End If
Проверка того, какие уровни трассировки включены, поможет избежать потенциально дорогостоящей обработки. В этом образце кода приложение позволяет отказаться от дополнительной обработки, если подробная трассировка уже включена. Напротив, приложение может сформировать выходные данные, только если включен определенный уровень трассировки.
Вопросы безопасности трассировки
Файлы трассировки могут содержать сведения о компьютерах (серверных и клиентских), о данных приложений и именах входа. (пароли в файл трассировки не записываются). Если включена подробная трассировка, каждая измененная строка из базы данных записывается в файл трассировки. Помогает защитить файл трассировки соответствующими списками управления доступом.
Полный пример кода
Приведенный ниже полный пример кода содержит ранее описанные в этом разделе примеры и дополнительный код синхронизации. Перед запуском этого приложения выполните следующие шаги.
Создайте проект в Visual Studio.
Добавьте ссылки на динамические библиотеки платформ Sync Framework и класс
Utility, расположенный в разделе Инструкции по классу Utility для поставщика базы данных.Создайте файл конфигурации и скопируйте код XML из примера, приведенного ранее в этом разделе.
Следует учитывать наличие двух вызовов методов в классе Utility:
util.MakeFailingChangesOnClient()Этот метод вносит на клиенте изменение, завершающееся с ошибкой при его применении на сервере. Нарушение ограничения и связанное исключение приложения автоматически записываются в файл трассировки в виде предупреждений.util.MakeConflictingChangesOnClientAndServer()Этот метод вносит на клиенте и сервере изменения, которые конфликтуют при их синхронизации. Сведения о конфликтах записываются в файл трассировки в обработчике событияSampleServerSyncProvider_ApplyChangeFailed.
После запуска приложения откройте выходной файл трассировки для просмотра сообщений, записанных автоматически, и предупреждений о конфликтах, возникших в результате выполнения кода приложения.
using System;
using System.IO;
using System.Text;
using System.Data;
using System.Data.SqlClient;
using System.Data.SqlServerCe;
using Microsoft.Synchronization;
using Microsoft.Synchronization.Data;
using Microsoft.Synchronization.Data.Server;
using Microsoft.Synchronization.Data.SqlServerCe;
namespace Microsoft.Samples.Synchronization
{
class Program
{
static void Main(string[] args)
{
//The SampleStats class handles information from the SyncStatistics
//object that the Synchronize method returns.
SampleStats sampleStats = new SampleStats();
//Delete and re-create the database. The client synchronization
//provider also enables you to create the client database
//if it does not exist.
Utility.SetPassword_SqlCeClientSync();
Utility.DeleteAndRecreateCompactDatabase(Utility.ConnStr_SqlCeClientSync, true);
//Write to the console which tracing levels are enabled. The app.config
//file specifies a value of 3 for the SyncTracer switch, which corresponds
//to Info. Therefore, Error, Warning, and Info return True, and Verbose
//returns False.
Console.WriteLine("");
Console.WriteLine("** Tracing Levels Enabled for this Application **");
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString());
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString());
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString());
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString());
//Initial synchronization. Instantiate the SyncAgent
//and call Synchronize.
SampleSyncAgent sampleSyncAgent = new SampleSyncAgent();
SyncStatistics syncStatistics = sampleSyncAgent.Synchronize();
sampleStats.DisplayStats(syncStatistics, "initial");
//Make a change at the client that fails when it is
//applied at the server. The constraint violation
//is automatically written to the trace file as a warning.
Utility.MakeFailingChangeOnClient();
//Make changes at the client and server that conflict
//when they are synchronized. The conflicts are written
//to the trace file in the SampleServerSyncProvider_ApplyChangeFailed
//event handler.
Utility.MakeConflictingChangesOnClientAndServer();
//Subsequent synchronization.
syncStatistics = sampleSyncAgent.Synchronize();
sampleStats.DisplayStats(syncStatistics, "subsequent");
//Return server data back to its original state.
Utility.CleanUpServer();
//Exit.
Console.Write("\nPress Enter to close the window.");
Console.ReadLine();
}
}
//Create a class that is derived from
//Microsoft.Synchronization.SyncAgent.
public class SampleSyncAgent : SyncAgent
{
public SampleSyncAgent()
{
//Instantiate a client synchronization provider and specify it
//as the local provider for this synchronization agent.
this.LocalProvider = new SampleClientSyncProvider();
//Instantiate a server synchronization provider and specify it
//as the remote provider for this synchronization agent.
this.RemoteProvider = new SampleServerSyncProvider();
//Add the Customer table: specify a synchronization direction of
//DownloadOnly.
SyncTable customerSyncTable = new SyncTable("Customer");
customerSyncTable.CreationOption = TableCreationOption.DropExistingOrCreateNewTable;
customerSyncTable.SyncDirection = SyncDirection.Bidirectional;
this.Configuration.SyncTables.Add(customerSyncTable);
}
}
//Create a class that is derived from
//Microsoft.Synchronization.Server.DbServerSyncProvider.
public class SampleServerSyncProvider : DbServerSyncProvider
{
public SampleServerSyncProvider()
{
//Create a connection to the sample server database.
Utility util = new Utility();
SqlConnection serverConn = new SqlConnection(Utility.ConnStr_DbServerSync);
this.Connection = serverConn;
//Create a command to retrieve a new anchor value from
//the server. In this case, we use a timestamp value
//that is retrieved and stored in the client database.
//During each synchronization, the new anchor value and
//the last anchor value from the previous synchronization
//are used: the set of changes between these upper and
//lower bounds is synchronized.
//
//SyncSession.SyncNewReceivedAnchor is a string constant;
//you could also use @sync_new_received_anchor directly in
//your queries.
SqlCommand selectNewAnchorCommand = new SqlCommand();
string newAnchorVariable = "@" + SyncSession.SyncNewReceivedAnchor;
selectNewAnchorCommand.CommandText = "SELECT " + newAnchorVariable + " = min_active_rowversion() - 1";
selectNewAnchorCommand.Parameters.Add(newAnchorVariable, SqlDbType.Timestamp);
selectNewAnchorCommand.Parameters[newAnchorVariable].Direction = ParameterDirection.Output;
selectNewAnchorCommand.Connection = serverConn;
this.SelectNewAnchorCommand = selectNewAnchorCommand;
//Create a SyncAdapter for the Customer table by using
//the SqlSyncAdapterBuilder:
// * Specify the base table and tombstone table names.
// * Specify the columns that are used to track when
// and where changes are made.
// * Specify bidirectional synchronization.
// * Call ToSyncAdapter to create the SyncAdapter.
// * Specify a name for the SyncAdapter that matches the
// the name specified for the corresponding SyncTable.
// Do not include the schema names (Sales in this case).
SqlSyncAdapterBuilder customerBuilder = new SqlSyncAdapterBuilder(serverConn);
customerBuilder.TableName = "Sales.Customer";
customerBuilder.TombstoneTableName = customerBuilder.TableName + "_Tombstone";
customerBuilder.SyncDirection = SyncDirection.Bidirectional;
customerBuilder.CreationTrackingColumn = "InsertTimestamp";
customerBuilder.UpdateTrackingColumn = "UpdateTimestamp";
customerBuilder.DeletionTrackingColumn = "DeleteTimestamp";
customerBuilder.CreationOriginatorIdColumn = "InsertId";
customerBuilder.UpdateOriginatorIdColumn = "UpdateId";
customerBuilder.DeletionOriginatorIdColumn = "DeleteId";
SyncAdapter customerSyncAdapter = customerBuilder.ToSyncAdapter();
customerSyncAdapter.TableName = "Customer";
this.SyncAdapters.Add(customerSyncAdapter);
//Handle the ApplyChangeFailed event. This allows us to write
//information to the trace file about any conflicts that occur.
this.ApplyChangeFailed += new EventHandler<ApplyChangeFailedEventArgs>(SampleServerSyncProvider_ApplyChangeFailed);
}
private void SampleServerSyncProvider_ApplyChangeFailed(object sender, ApplyChangeFailedEventArgs e)
{
//Verbose tracing includes information about conflicts. In this application,
//Verbose tracing is disabled, and we have decided to flag conflicts with a
//warning.
//Check if Verbose tracing is enabled and if the conflict is an error.
//If the conflict is not an error, we write a warning to the trace file
//with information about the conflict.
if (SyncTracer.IsVerboseEnabled() == false && e.Conflict.ConflictType != ConflictType.ErrorsOccurred)
{
DataTable conflictingServerChange = e.Conflict.ServerChange;
DataTable conflictingClientChange = e.Conflict.ClientChange;
int serverColumnCount = conflictingServerChange.Columns.Count;
int clientColumnCount = conflictingClientChange.Columns.Count;
StringBuilder clientRowAsString = new StringBuilder();
StringBuilder serverRowAsString = new StringBuilder();
for (int i = 0; i < clientColumnCount; i++)
{
clientRowAsString.Append(conflictingClientChange.Rows[0][i] + " | ");
}
for (int i = 0; i < serverColumnCount; i++)
{
serverRowAsString.Append(conflictingServerChange.Rows[0][i] + " | ");
}
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId);
SyncTracer.Warning(2, "** Client change **");
SyncTracer.Warning(2, clientRowAsString.ToString());
SyncTracer.Warning(2, "** Server change **");
SyncTracer.Warning(2, serverRowAsString.ToString());
}
}
}
//Create a class that is derived from
//Microsoft.Synchronization.Data.SqlServerCe.SqlCeClientSyncProvider.
//You can just instantiate the provider directly and associate it
//with the SyncAgent, but you could use this class to handle client
//provider events and other client-side processing.
public class SampleClientSyncProvider : SqlCeClientSyncProvider
{
public SampleClientSyncProvider()
{
//Specify a connection string for the sample client database.
Utility util = new Utility();
this.ConnectionString = Utility.ConnStr_SqlCeClientSync;
this.SchemaCreated += new EventHandler<SchemaCreatedEventArgs>(SampleClientSyncProvider_SchemaCreated);
}
private void SampleClientSyncProvider_SchemaCreated(object sender, SchemaCreatedEventArgs e)
{
string tableName = e.Table.TableName;
Utility util = new Utility();
//Call ALTER TABLE on the client. This must be done
//over the same connection and within the same
//transaction that Sync Framework uses
//to create the schema on the client.
Utility.MakeSchemaChangesOnClient(e.Connection, e.Transaction, "Customer");
}
}
//Handle the statistics that are returned by the SyncAgent.
public class SampleStats
{
public void DisplayStats(SyncStatistics syncStatistics, string syncType)
{
Console.WriteLine(String.Empty);
if (syncType == "initial")
{
Console.WriteLine("****** Initial Synchronization ******");
}
else if (syncType == "subsequent")
{
Console.WriteLine("***** Subsequent Synchronization ****");
}
Console.WriteLine("Start Time: " + syncStatistics.SyncStartTime);
Console.WriteLine("Total Changes Downloaded: " + syncStatistics.TotalChangesDownloaded);
Console.WriteLine("Total Changes Uploaded: " + syncStatistics.TotalChangesUploaded);
Console.WriteLine("Complete Time: " + syncStatistics.SyncCompleteTime);
Console.WriteLine(String.Empty);
}
}
}
Imports System
Imports System.IO
Imports System.Text
Imports System.Data
Imports System.Data.SqlClient
Imports System.Data.SqlServerCe
Imports Microsoft.Synchronization
Imports Microsoft.Synchronization.Data
Imports Microsoft.Synchronization.Data.Server
Imports Microsoft.Synchronization.Data.SqlServerCe
Class Program
Shared Sub Main(ByVal args() As String)
'The SampleStats class handles information from the SyncStatistics
'object that the Synchronize method returns.
Dim sampleStats As New SampleStats()
'Delete and re-create the database. The client synchronization
'provider also enables you to create the client database
'if it does not exist.
Utility.SetPassword_SqlCeClientSync()
Utility.DeleteAndRecreateCompactDatabase(Utility.ConnStr_SqlCeClientSync, True)
'Write to the console which tracing levels are enabled. The app.config
'file specifies a value of 3 for the SyncTracer switch, which corresponds
'to Info. Therefore, Error, Warning, and Info return True, and Verbose
'returns False.
Console.WriteLine("")
Console.WriteLine("** Tracing Levels Enabled for this Application **")
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString())
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString())
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString())
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString())
'Initial synchronization. Instantiate the SyncAgent
'and call Synchronize.
Dim sampleSyncAgent As New SampleSyncAgent()
Dim syncStatistics As SyncStatistics = sampleSyncAgent.Synchronize()
sampleStats.DisplayStats(syncStatistics, "initial")
'Make a change at the client that fails when it is
'applied at the server. The constraint violation
'is automatically written to the trace file as a warning.
Utility.MakeFailingChangeOnClient()
'Make changes at the client and server that conflict
'when they are synchronized. The conflicts are written
'to the trace file in the SampleServerSyncProvider_ApplyChangeFailed
'event handler.
Utility.MakeConflictingChangesOnClientAndServer()
'Subsequent synchronization.
syncStatistics = sampleSyncAgent.Synchronize()
sampleStats.DisplayStats(syncStatistics, "subsequent")
'Return server data back to its original state.
Utility.CleanUpServer()
'Exit.
Console.Write(vbLf + "Press Enter to close the window.")
Console.ReadLine()
End Sub 'Main
End Class 'Program
'Create a class that is derived from
'Microsoft.Synchronization.SyncAgent.
Public Class SampleSyncAgent
Inherits SyncAgent
Public Sub New()
'Instantiate a client synchronization provider and specify it
'as the local provider for this synchronization agent.
Me.LocalProvider = New SampleClientSyncProvider()
'Instantiate a server synchronization provider and specify it
'as the remote provider for this synchronization agent.
Me.RemoteProvider = New SampleServerSyncProvider()
'Add the Customer table: specify a synchronization direction of
'DownloadOnly.
Dim customerSyncTable As New SyncTable("Customer")
customerSyncTable.CreationOption = TableCreationOption.DropExistingOrCreateNewTable
customerSyncTable.SyncDirection = SyncDirection.Bidirectional
Me.Configuration.SyncTables.Add(customerSyncTable)
End Sub 'New
End Class 'SampleSyncAgent
'Create a class that is derived from
'Microsoft.Synchronization.Server.DbServerSyncProvider.
Public Class SampleServerSyncProvider
Inherits DbServerSyncProvider
Public Sub New()
'Create a connection to the sample server database.
Dim util As New Utility()
Dim serverConn As New SqlConnection(Utility.ConnStr_DbServerSync)
Me.Connection = serverConn
'Create a command to retrieve a new anchor value from
'the server. In this case, we use a timestamp value
'that is retrieved and stored in the client database.
'During each synchronization, the new anchor value and
'the last anchor value from the previous synchronization
'are used: the set of changes between these upper and
'lower bounds is synchronized.
'
'SyncSession.SyncNewReceivedAnchor is a string constant;
'you could also use @sync_new_received_anchor directly in
'your queries.
Dim selectNewAnchorCommand As New SqlCommand()
Dim newAnchorVariable As String = "@" + SyncSession.SyncNewReceivedAnchor
selectNewAnchorCommand.CommandText = "SELECT " + newAnchorVariable + " = min_active_rowversion() - 1"
selectNewAnchorCommand.Parameters.Add(newAnchorVariable, SqlDbType.Timestamp)
selectNewAnchorCommand.Parameters(newAnchorVariable).Direction = ParameterDirection.Output
selectNewAnchorCommand.Connection = serverConn
Me.SelectNewAnchorCommand = selectNewAnchorCommand
'Create a SyncAdapter for the Customer table by using
'the SqlSyncAdapterBuilder:
' * Specify the base table and tombstone table names.
' * Specify the columns that are used to track when
' and where changes are made.
' * Specify bidirectional synchronization.
' * Call ToSyncAdapter to create the SyncAdapter.
' * Specify a name for the SyncAdapter that matches the
' the name specified for the corresponding SyncTable.
' Do not include the schema names (Sales in this case).
Dim customerBuilder As New SqlSyncAdapterBuilder(serverConn)
customerBuilder.TableName = "Sales.Customer"
customerBuilder.TombstoneTableName = customerBuilder.TableName + "_Tombstone"
customerBuilder.SyncDirection = SyncDirection.Bidirectional
customerBuilder.CreationTrackingColumn = "InsertTimestamp"
customerBuilder.UpdateTrackingColumn = "UpdateTimestamp"
customerBuilder.DeletionTrackingColumn = "DeleteTimestamp"
customerBuilder.CreationOriginatorIdColumn = "InsertId"
customerBuilder.UpdateOriginatorIdColumn = "UpdateId"
customerBuilder.DeletionOriginatorIdColumn = "DeleteId"
Dim customerSyncAdapter As SyncAdapter = customerBuilder.ToSyncAdapter()
customerSyncAdapter.TableName = "Customer"
Me.SyncAdapters.Add(customerSyncAdapter)
'Handle the ApplyChangeFailed event. This allows us to write
'information to the trace file about any conflicts that occur.
AddHandler Me.ApplyChangeFailed, AddressOf SampleServerSyncProvider_ApplyChangeFailed
End Sub 'New
Private Sub SampleServerSyncProvider_ApplyChangeFailed(ByVal sender As Object, ByVal e As ApplyChangeFailedEventArgs)
'Verbose tracing includes information about conflicts. In this application,
'Verbose tracing is disabled, and we have decided to flag conflicts with a
'warning.
'Check if Verbose tracing is enabled and if the conflict is an error.
'If the conflict is not an error, we write a warning to the trace file
'with information about the conflict.
If SyncTracer.IsVerboseEnabled() = False AndAlso e.Conflict.ConflictType <> ConflictType.ErrorsOccurred Then
Dim conflictingServerChange As DataTable = e.Conflict.ServerChange
Dim conflictingClientChange As DataTable = e.Conflict.ClientChange
Dim serverColumnCount As Integer = conflictingServerChange.Columns.Count
Dim clientColumnCount As Integer = conflictingClientChange.Columns.Count
Dim clientRowAsString As New StringBuilder()
Dim serverRowAsString As New StringBuilder()
Dim i As Integer
For i = 1 To clientColumnCount - 1
clientRowAsString.Append(conflictingClientChange.Rows(0)(i).ToString() & " | ")
Next i
For i = 1 To serverColumnCount - 1
serverRowAsString.Append(conflictingServerChange.Rows(0)(i).ToString() & " | ")
Next i
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId)
SyncTracer.Warning(2, "** Client change **")
SyncTracer.Warning(2, clientRowAsString.ToString())
SyncTracer.Warning(2, "** Server change **")
SyncTracer.Warning(2, serverRowAsString.ToString())
End If
End Sub 'SampleServerSyncProvider_ApplyChangeFailed
End Class 'SampleServerSyncProvider
'Create a class that is derived from
'Microsoft.Synchronization.Data.SqlServerCe.SqlCeClientSyncProvider.
'You can just instantiate the provider directly and associate it
'with the SyncAgent, but you could use this class to handle client
'provider events and other client-side processing.
Public Class SampleClientSyncProvider
Inherits SqlCeClientSyncProvider
Public Sub New()
'Specify a connection string for the sample client database.
Dim util As New Utility()
Me.ConnectionString = Utility.ConnStr_SqlCeClientSync
End Sub 'New
Private Sub SampleClientSyncProvider_SchemaCreated(ByVal sender As Object, ByVal e As SchemaCreatedEventArgs)
Dim tableName As String = e.Table.TableName
Dim util As New Utility()
'Call ALTER TABLE on the client. This must be done
'over the same connection and within the same
'transaction that Sync Framework uses
'to create the schema on the client.
Utility.MakeSchemaChangesOnClient(e.Connection, e.Transaction, "Customer")
End Sub 'SampleClientSyncProvider_SchemaCreated
End Class 'SampleClientSyncProvider
'Handle the statistics that are returned by the SyncAgent.
Public Class SampleStats
Public Sub DisplayStats(ByVal syncStatistics As SyncStatistics, ByVal syncType As String)
Console.WriteLine(String.Empty)
If syncType = "initial" Then
Console.WriteLine("****** Initial Synchronization ******")
ElseIf syncType = "subsequent" Then
Console.WriteLine("***** Subsequent Synchronization ****")
End If
Console.WriteLine("Start Time: " & syncStatistics.SyncStartTime)
Console.WriteLine("Total Changes Downloaded: " & syncStatistics.TotalChangesDownloaded)
Console.WriteLine("Total Changes Uploaded: " & syncStatistics.TotalChangesUploaded)
Console.WriteLine("Complete Time: " & syncStatistics.SyncCompleteTime)
Console.WriteLine(String.Empty)
End Sub 'DisplayStats
End Class 'SampleStats
См. также
Основные положения
Программирование распространенных задач синхронизации клиента и сервера