Переносимые библиотеки классов (PCL)Portable Class Libraries (PCL)

Совет

Переносимые библиотеки классов (PCL), считаются устаревшими в последних версиях Visual Studio.Portable Class Libraries (PCLs) are considered deprecated in the latest versions of Visual Studio. Хотя по-прежнему можно открыть, изменить и скомпилировать PCL, для новых проектов рекомендуется использовать библиотеки .NET Standard для доступа к большую контактную зону API.While you can still open, edit, and compile PCLs, for new projects it is recommended to use .NET Standard libraries to access a larger API surface area.

Ключевым компонентом создания кросс платформенных приложений является возможность совместно использовать код в различные проекты под конкретные платформы.A key component of building cross-platform applications is being able to share code across various platform-specific projects. Тем не менее это осложняется тем, что часто использоваться другой набор вложенных библиотеки классов .NET Base (BCL) различных платформ и таким образом, будут построены на другой профиль библиотеки .NET Core.However, this is complicated by the fact that different platforms often use a different sub-set of the .NET Base Class Library (BCL), and therefore are actually built to a different .NET Core Library Profile. Это означает, что каждой платформы можно использовать только библиотеки классов, которые нацелены на тот же профиль, чтобы они отображались требовать отдельных проектов библиотеки классов для каждой платформы.This means that each platform can only use class libraries that are targeted to the same profile so they would appear to require separate class library projects for each platform.

Существует три основных подхода к совместного использования кода для устранения этой проблемы: проектов .NET Standard, проектах общих ресурсов, и проекты переносимой библиотеки классов (PCL).There are three major approaches to code sharing that address this problem: .NET Standard projects, Shared Asset Projects, and Portable Class Library (PCL) projects.

  • Проектов .NET standard являются предпочтительным подходом для совместного использования кода .NET, Узнайте больше о проектов .NET Standard и Xamarin..NET Standard projects are the preferred approach for sharing .NET code, read more about .NET Standard projects and Xamarin.
  • Общие проекты активов использовать один набор файлов и предлагает простой и быстрый способ для совместного использования кода в решении и обычно использует директивы условной компиляции, чтобы указывать пути кода для различных платформ, которые будут его использовать (для получения дополнительных сведений сведения см. в разделе статье проектах общих).Shared Asset Projects use a single set of files and offers a quick and simple way in which to share code within a solution and generally employs conditional compilation directives to specify code paths for various platforms that will use it (for more information see the Shared Projects article).
  • PCL проекты предназначены для конкретные профили, поддерживающие известный набор классов BCL/features.PCL projects target specific profiles that support a known set of BCL classes/features. Отрицательной стороной переносимую библиотеку классов то, что они часто требуют очень архитектуры усилий для разделения кода конкретного профиля на собственные библиотеки.However, the down side to PCL is that they often require extra architectural effort to separate profile specific code into their own libraries.

Этой странице объясняется, как создать PCL проект, предназначенный для конкретного профиля, который можно затем ссылаться на несколько проектов для конкретных платформ.This page explains how to create a PCL project that targets a specific profile, which can then be referenced by multiple platform-specific projects.

Что такое переносимой библиотеки классовWhat is a Portable Class Library?

При создании проекта приложения или проект библиотеки, итоговому файлу DLL будет ограничен работа на конкретную платформу, для которого он создан.When you create an Application Project or a Library Project, the resulting DLL is restricted to working on the specific platform it is created for. Это позволяет записывая сборку для приложения Windows, а затем повторно использовать его на Xamarin.iOS и Xamarin.Android.This prevents you from writing an assembly for a Windows app, and then re-using it on Xamarin.iOS and Xamarin.Android.

При создании переносимой библиотеки классов, тем не менее, можно выбрать сочетание платформ, которые требуется код для запуска на.When you create a Portable Class Library, however, you can choose a combination of platforms that you want your code to run on. Выбор совместимости, внесенные при создании переносимой библиотеки классов, преобразуются в «Профиль» идентификатор, описывающий, какие платформы, библиотека поддерживает.The compatibility choices you make when creating a Portable Class Library are translated into a “Profile” identifier, which describes which platforms the library supports.

В следующей таблице показаны некоторые функции, которые зависят от платформы .NET.The table below shows some of the features that vary by .NET platform. Чтобы создать сборку переносимой библиотеки Классов, выполнение на определенных устройствах и платформах нужно просто выбрать какие поддержки является обязательным при создании проекта.To write a PCL assembly that is guaranteed to run on specific devices/platforms you simply choose which support is required when you create the project.

ФункцияFeature .NET Framework.NET Framework Приложения универсальной платформы WindowsUWP apps SilverlightSilverlight Windows PhoneWindows Phone XamarinXamarin
ЯдроCore YY YY YY YY YY
LINQLINQ YY YY YY YY YY
IQueryableIQueryable YY YY YY 7.5 +7.5 + YY
СериализацияSerialization YY YY YY YY YY
Заметки к даннымData Annotations 4.0.3 +4.0.3 + YY YY YY

Столбце Xamarin отражен тот факт, что Xamarin.iOS и Xamarin.Android поддерживает все профили, поставляемых с Visual Studio, и доступность функций во всех библиотеках, создаваемых будет ограничен только других платформ, выбранный для поддержки.The Xamarin column reflects the fact that Xamarin.iOS and Xamarin.Android supports all the profiles shipped with Visual Studio, and the availability of features in any libraries you create will only be limited by the other platforms you choose to support.

Сюда также входят профили, которые являются комбинацией:This includes profiles that are combinations of:

  • .NET 4 или .NET 4.5.NET 4 or .NET 4.5
  • Silverlight 5Silverlight 5
  • Windows Phone 8Windows Phone 8
  • Приложения универсальной платформы WindowsUWP apps

Дополнительные сведения о возможностях различные профили на веб-сайта корпорации Майкрософт и другой участник сообщества см. в разделе профиль PCL сводки включающее поддерживается framework сведения и другие примечания.You can read more about the different profiles' capabilities on Microsoft’s website and see another community member's PCL profile summary which includes supported framework info and other notes.

ПреимуществаBenefits

  1. Совместного использования централизованной кода — писать и тестировать код в одном проекте, могут использоваться другие библиотеки или приложения.Centralized code sharing – write and test code in a single project that can be consumed by other libraries or applications.
  2. Операции рефакторинга будет влиять на весь код загружен в решение (переносимой библиотеки классов и проекты под конкретные платформы).Refactoring operations will affect all code loaded in the solution (the Portable Class Library and the platform-specific projects).
  3. Проект переносимой библиотеки Классов можно легко ссылаться на другие проекты в решении или выходной сборки может использоваться для других пользователей, для ссылки в своих решениях.The PCL project can be easily referenced by other projects in a solution, or the output assembly can be shared for others to reference in their solutions.

НедостаткиDisadvantages

  1. Так как же переносимой библиотеки классов распределена между несколькими приложениями, специфические для платформы библиотеки не могут ссылаться (например)Because the same Portable Class Library is shared between multiple applications, platform-specific libraries cannot be referenced (eg. Community.CsharpSqlite.WP7).Community.CsharpSqlite.WP7).
  2. Подмножество переносимой библиотеки классов не может содержать классы, которые в противном случае будут доступны в MonoTouch и Mono для Android (например, DllImport или System.IO.File).The Portable Class Library subset may not include classes that would otherwise be available in both MonoTouch and Mono for Android (such as DllImport or System.IO.File).

Примечание

Переносимые библиотеки классов, которые стали нерекомендуемыми в последнюю версию Visual Studio и библиотеки .NET Standard вместо этого рекомендуется использовать.Portable Class Libraries have been deprecated in the latest version of Visual Studio, and .NET Standard Libraries are recommended instead.

В некоторой степени обоих недостатки можно обойти с помощью шаблона поставщика или внедрение зависимостей для кода фактическую реализацию в проектах платформы для интерфейса или базового класса, который определен в переносимой библиотеке классов.To some extent both disadvantages can be circumvented using the Provider pattern or Dependency Injection to code the actual implementation in the platform projects against an interface or base class that is defined in the Portable Class Library.

На этой схеме показана архитектура кросс платформенные приложения с помощью переносимой библиотеки классов для совместного использования кода, но также с помощью внедрения зависимости для передачи в возможности, зависящие от платформы.This diagram shows the architecture of a cross-platform application using a Portable Class Library to share code, but also using Dependency Injection to pass in platform-dependent features:

Visual Studio для Mac Пошаговое руководствоVisual Studio for Mac walkthrough

В этом разделе описано, как создать и использовать переносимую библиотеку классов с помощью Visual Studio для Mac.This section walks through how to create and use a Portable Class Library using Visual Studio for Mac. См. в разделе примера PCL полную реализацию.Refer the to PCL Example section for a complete implementation.

Создание PCLCreating a PCL

Добавление переносимой библиотеки классов в решение очень сходно с добавлением обычного проекта библиотеки.Adding a Portable Class Library to your solution is very similar to adding a regular Library project.

  1. В новый проект окна выберите Многоплатформенность > Библиотека > переносимой библиотеки параметр:In the New Project dialog select the Multiplatform > Library > Portable Library option:

    Создание нового проекта переносимой библиотеки Классов

  2. При создании переносимой библиотеки Классов в Visual Studio для Mac автоматически настраивается с профилем, подходящий для Xamarin.iOS и Xamarin.Android.When a PCL is created in Visual Studio for Mac it is automatically configured with a Profile that works for Xamarin.iOS and Xamarin.Android. Проект PCL. ОНИ будут отображаться, как показано на следующем снимке экрана:The PCL project will appear as shown in this screenshot:

    Проект переносимой библиотеки Классов на панели решения

Переносимая библиотека Классов теперь готов для кода для добавления.The PCL is now ready for code to be added. Его можно также ссылаться на другие проекты (проекты приложений, проекты библиотек и даже в других проектах переносимой библиотеки Классов).It can also be referenced by other projects (Application projects, Library projects and even other PCL projects).

Изменение параметров переносимой библиотеки КлассовEditing PCL settings

Чтобы просмотреть и изменить параметры для этого проекта переносимой библиотеки Классов, щелкните правой кнопкой мыши проект и выберите параметры > Создать > Общие . появится экран, показанный здесь:To view and change the PCL settings for this project, right-click the project and choose Options > Build > General to see the screen shown here:

Параметры проекта переносимой библиотеки Классов для установки профиляPCL Project Options to set the profile

Нажмите кнопку изменений... для изменения целевой профиль для этого переносимой библиотеки классов.Click Change... to alter the target profile for this portable class library.

Если профиль изменяется после кода уже был добавлен в переносимую библиотеку классов, это возможно, что библиотека больше не будут компилироваться, если код ссылается на функции, которые не являются частью вновь выбранного профиля.If the profile is changed after code has already been added to the PCL, it's possible that the library will no longer compile if the code references features that are not part of the newly-selected profile.

Работа с PCLWorking with a PCL

При создании кода в библиотеке переносимой библиотеки Классов, редактор Visual Studio для Mac распознает ограничения выбранного профиля и соответствующим образом настроить параметры автозаполнения.When code is written in a PCL library, the Visual Studio for Mac editor will recognize the limitations of the selected profile and adjust auto-complete options accordingly. Например, на этом снимке экрана показаны варианты автозавершения для System.IO с использованием профиля по умолчанию (Profile136), используемых в Visual Studio для Mac — Обратите внимание, который указывает, около половины всех доступных классов отображаются полосы прокрутки (на самом деле существует только 14 классы доступны).For example, this screenshot shows the auto-complete options for System.IO using the default profile (Profile136) used in Visual Studio for Mac – notice the scrollbar which indicates about half of the available classes are displayed (in fact there are only 14 classes available).

Список IntelliSense 14 классов в классе System.IO PCLIntellisense list of 14 classes in the System.IO class of a PCL

Сравнить с System.IO, автозавершения в проекте Xamarin.iOS или Xamarin.Android —, 40 классы, доступные включая часто используемые классы, как File и Directory которого не принадлежат ни одному профилю PCL.Compare that with the System.IO auto-complete in a Xamarin.iOS or Xamarin.Android project – there are 40 classes available including commonly used classes like File and Directory which are not in any PCL profile.

Список IntelliSense 40 классы в пространстве имен .NET Framework System.IOIntellisense list of 40 classes in .NET Framework System.IO namespace

Это отражает базовой компромисс с помощью переносимой библиотеки Классов — возможность легко совместное использование кода на многих платформах означает, что некоторые API вам недоступны, поскольку они не имеют сравнимые реализации для всех возможных платформ.This reflects the underlying trade-off of using PCL – the ability to share code seamlessly across many platforms means certain APIs are not available to you because they don’t have comparable implementations across all possible platforms.

С помощью переносимой библиотеки КлассовUsing PCL

После создания проекта переносимой библиотеки Классов, можно добавить ссылку на него из любой проектов, совместимый с приложения или библиотеки таким же образом, обычно добавляются ссылки.Once a PCL project has been created, you can add a reference to it from any compatible Application or Library project in the same way you normally add references. В Visual Studio для Mac, щелкните правой кнопкой мыши на узел "ссылки" и выберите изменить ссылки... переключитесь проекты как показано:In Visual Studio for Mac, right-click on the References node and choose Edit References... then switch to the Projects tab as shown:

Добавьте ссылку на переносимую библиотеку Классов с помощью параметра Изменить ссылкиAdd a reference to a PCL via Edit References option

На следующем рисунке показаны панели решения для примера приложения TaskyPortable, показывающий библиотеки PCL снизу и ссылку на эту библиотеку PCL в проекте Xamarin.iOS.The following screenshot shows the Solution pad for the TaskyPortable sample app, showing the PCL library at the bottom and a reference to that PCL library in the Xamarin.iOS project.

Пример решения TaskyPortable отображение-проект переносимой библиотеки КлассовTaskyPortable sample solution showing PCL project

Выходные данные из библиотеки PCL (т. е. сборку библиотеки DLL) можно также добавить как ссылку для большинства проектов.The output from a PCL (ie. the resulting assembly DLL) can also be added as a reference to most projects. Это делает идеальное решение для отправки кроссплатформенных компоненты и библиотеки PCL.This makes PCL an ideal way to ship cross-platform components and libraries.

Пример PCLPCL example

TaskyPortable пример приложения демонстрирует, как можно использовать переносимую библиотеку классов с помощью Xamarin.The TaskyPortable sample application demonstrates how a Portable Class Library can be used with Xamarin. Ниже приведены некоторые снимки экрана итоговый приложения, работающие на iOS и Android.Here are some screenshots of the resulting apps running on iOS and Android:

Он использует ряд классов данных и логики, которые являются исключительно переносимого кода, а также показано, как включить требования платформы, с помощью внедрения зависимостей для реализации базы данных SQLite.It shares a number of data and logic classes that are purely portable code, and it also demonstrates how to incorporate platform-specific requirements using Dependency Injection for the SQLite database implementation.

Ниже приведен структуру решения (в Visual Studio для Mac и Visual Studio соответственно):The solution structure is shown below (in Visual Studio for Mac and Visual Studio respectively):

Так как SQLite-NET-код содержит специфические для платформы (Чтобы работать с реализациями SQLite на каждый другой операционной системы) для демонстрационных целей, он были вынесены в абстрактный класс, который может быть скомпилирован в переносимую библиотеку классов, и фактический код, реализованный как подклассы в проекты iOS и Android.Because the SQLite-NET code has platform-specific pieces (to work with the SQLite implementations on each different operating system) for demonstration purposes it has been refactored into an abstract class that can be compiled into a Portable Class Library, and the actual code implemented as subclasses in the iOS and Android projects.

TaskyPortableLibraryTaskyPortableLibrary

Компоненты .NET, которые может поддерживать ограничен переносимой библиотеки классов.The Portable Class Library is limited in the .NET features that it can support. Так как она компилируется для запуска на нескольких платформах, не могут вносить использование [DllImport] функциональность, которая используется в SQLite-NET.Because it is compiled to run on multiple platforms, it cannot make use of [DllImport] functionality that is used in SQLite-NET. Вместо SQLite-NET реализуется как абстрактный класс и затем ссылаться через оставшуюся часть совместно используемого кода.Instead SQLite-NET is implemented as an abstract class, and then referenced through the rest of the shared code. Ниже приводится его абстрактный API.An extract of the abstract API is shown below:

public abstract class SQLiteConnection : IDisposable {

    public string DatabasePath { get; private set; }
    public bool TimeExecution { get; set; }
    public bool Trace { get; set; }
    public SQLiteConnection(string databasePath) {
         DatabasePath = databasePath;
    }
    public abstract int CreateTable<T>();
    public abstract SQLiteCommand CreateCommand(string cmdText, params object[] ps);
    public abstract int Execute(string query, params object[] args);
    public abstract List<T> Query<T>(string query, params object[] args) where T : new();
    public abstract TableQuery<T> Table<T>() where T : new();
    public abstract T Get<T>(object pk) where T : new();
    public bool IsInTransaction { get; protected set; }
    public abstract void BeginTransaction();
    public abstract void Rollback();
    public abstract void Commit();
    public abstract void RunInTransaction(Action action);
    public abstract int Insert(object obj);
    public abstract int Update(object obj);
    public abstract int Delete<T>(T obj);

    public void Dispose()
    {
        Close();
    }
    public abstract void Close();

}

Остальная часть совместно используемого кода использует абстрактный класс для «магазин» и «получить» объекты из базы данных.The remainder of the shared code uses the abstract class to “store” and “retrieve” objects from the database. В любое приложение, использующее этого абстрактного класса необходимо передать в полную реализацию функциональности реальной базы данных.In any application that uses this abstract class we must pass in a complete implementation that provides the actual database functionality.

TaskyAndroid и TaskyiOSTaskyAndroid and TaskyiOS

В iOS и в проектах приложений Android содержатся пользовательского интерфейса и другие специфические для платформы код, используемый для передачи up общий код в переносимой библиотеке Классов.The iOS and Android application projects contain the user-interface and other platform-specific code used to wire-up the shared code in the PCL.

Эти проекты также содержат реализацию абстрактного базы данных API, который работает на этой платформе.These projects also contain an implementation of the abstract database API that works on that platform. В iOS и Android Sqlite компонент database engine встроены в операционную систему, чтобы можно было использовать реализацию [DllImport] как показано для предоставления конкретная реализация подключение к базе данных.On iOS and Android the Sqlite database engine is built-in to the operating system, so the implementation can use [DllImport] as shown to provide the concrete implementation of database connectivity. Ниже приведен фрагмент кода реализации конкретной платформы.An excerpt of the platform-specific implementation code is shown here:

[DllImport("sqlite3", EntryPoint = "sqlite3_open")]
public static extern Result Open(string filename, out IntPtr db);

[DllImport("sqlite3", EntryPoint = "sqlite3_close")]
public static extern Result Close(IntPtr db);

Полная реализация видно в примере кода.The full implementation can be seen in the sample code.

СводкаSummary

В этой статье кратко обсуждается преимуществах и недостатках переносимые библиотеки классов, было продемонстрировано, как создавать и использовать PCL из среды Visual Studio для Mac и Visual Studio. и наконец появился полный пример приложения — TaskyPortable —, которое показывает PCL в действии.This article has briefly discussed the benefits and pitfalls of Portable Class Libraries, demonstrated how to create and consume PCLs from inside Visual Studio for Mac and Visual Studio; and finally introduced a complete sample application – TaskyPortable – that shows a PCL in action.