Переносимые библиотеки классов (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. Однако это усложняется тем, что на разных платформах часто используется другой поднабор библиотеки базовых классов (BCL) .NET, и, следовательно, они построены в другом профиле библиотеки .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.PCL projects target specific profiles that support a known set of BCL classes/features. Однако из-за недостаточной части в PCL часто требуются дополнительные архитектурные усилия для разделения кода конкретного профиля на собственные библиотеки.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. Варианты совместимости, вносимые при создании переносимой библиотеки классов, преобразуются в идентификатор "Profile", который описывает платформы, поддерживаемые библиотекой.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. Для написания сборки PCL, которая гарантированно будет выполняться на конкретных устройствах и платформах, вы просто выбираете, какая поддержка необходима при создании проекта.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 , включающую сведения о поддерживаемых платформах и другие примечания.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. На проект PCL можно легко ссылаться из других проектов в решении, или выходную сборку можно использовать совместно, чтобы другие пользователи могли ссылаться на них в своих решениях.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. Кшарпсклите. WP7).Community.CsharpSqlite.WP7).
  2. Подмножество переносимой библиотеки классов может не включать классы, которые в противном случае были бы доступны как с помощью монохромного касания, так и 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 для MacVisual 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:

    Создание нового проекта PCL

  2. При создании PCL в 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:

    Проект PCL на панели решения

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

Изменение параметров PCLEditing PCL settings

Чтобы просмотреть и изменить параметры PCL для этого проекта, щелкните проект правой кнопкой мыши и выберите параметры > сборка > общие , чтобы увидеть показанный здесь экран: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 для задания профиляPCL Project Options to set the profile

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

Если профиль был изменен после добавления кода в PCL, то возможно, что библиотека больше не будет компилироваться, если код ссылается на компоненты, которые не являются частью вновь выбранного профиля.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

При написании кода в библиотеке 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 в пространстве имен System.IO .NET FrameworkIntellisense list of 40 classes in .NET Framework System.IO namespace

Это отражает базовую компромисс использования PCL — возможность беспрепятственного совместного использования кода на многих платформах означает, что некоторые 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.

Использование PCLUsing PCL

После создания проекта 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:

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

На следующем снимке экрана показана панель решения для примера приложения Таскипортабле, которая показывает библиотеку 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.

Образец решения Таскипортабле, демонстрирующий проект PCLTaskyPortable sample solution showing PCL project

Выходные данные PCL (Internet Explorer, результирующая сборка 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

В примере приложения таскипортабле показано, как можно использовать переносимую библиотеку классов с 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.

таскипортаблелибрариTaskyPortableLibrary

Переносимая библиотека классов ограничена функциями .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 and TaskyiOS

Проекты приложений iOS и Android содержат пользовательский интерфейс и другой код, зависящий от платформы, используемый для подключения общего кода в PCL.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 встроено в операционную систему, поэтому реализация может использовать [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. и, наконец, появился полный пример приложения — Таскипортабле —, в котором показана 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.