Это хорошее решение для локализации подключаемых компонентов?

Question

Ранее я задавал вопрос , на который был только один ответ. У меня было немного времени, чтобы поиграть с этим и составить план, но я хочу получить отзывы, если это хорошая идея.

Проблема:

Я хочу, чтобы компонент с именем (инвариант, используемый для идентификации компонента) локализовал свое имя в приложении, которое его потребляет, без загрязнения модели компонента атрибутом DisplayName. Компонент может существовать в отдельной dll и динамически загружаться во время выполнения.

я чувствую, что компонент dll должен отвечать за предоставление локализованного имени (это похоже на хорошую инкапсуляцию), но приложение, потребляющее компонент, должно отвечать за получение / использование локализованного имени (тот факт, что компонент имеет другое имя для целей отображения - это не проблема компонента, а «представление», использующее этот компонент)

Решение:

Добавьте ресурс к dll компонентов с тем же именем, что и файл, в котором находится класс компонента. Добавьте строку к ресурсу с ключом, который является именем компонента.

В приложении получите локализованное имя примерно так:

ExternalObject obj = GetExternalObject ();            
ResourceManager manager = new ResourceManager (obj.GetType ());
string localisedName= manager.GetString (obj.Name);

Этот код, вероятно, будет инкапсулирован в класс Localiser, но передает смысл. Кажется, это работает, но это хорошая идея или есть лучший / более стандартный способ сделать это?

РЕДАКТИРОВАТЬ: я должен отметить, что одна вещь, в которой я не уверен, с этим решением, что ресурсы должны быть в файле .resx, имя которого совпадает с именем файла, в котором находится класс. это работает, поскольку файл ресурса может быть идентифицирован от имени типа. Это то же самое, что локализация для форм, кажется, работает, и визуальная студия помещает .resx в качестве «подкомпонента» файла .cs, что все выглядит хорошо. Но Visual Studio затем выдает предупреждение (о редактировании ресурса, который является частью другого элемента проекта), если я пытаюсь отредактировать этот файл, что заставляет меня думать, что, возможно, есть какой-то другой способ, которым я должен это делать.

Answer 1

Я думаю, у вас есть правильная идея, но есть лучший способ сделать это.

Предположительно, у вас есть интерфейс, который реализует подключаемый компонент. Скажите, IPluggable:

interface IPluggable {
    ...
    string LocalizedName {get;}
    ...
}

Из вашего основного двоичного файла загрузите подключаемую сборку и создайте экземпляр IPluggable, используя отражение (я полагаю, это то, что у вас есть метод GetExternalObject()), а затем получите доступ к локализованному имени, используя свойство LocalizedName. Внутри реализации IPluggable создайте ResourceManager и получите доступ к LocalizedName с помощью resx этой подключаемой сборки.

То, что вы делаете, - это хорошая инкапсуляция поведения в подключаемой сборке - она ​​отвечает за предоставление вам локализованного имени, однако предпочитает это делать, при этом ваша программа man не предполагает, что для доступа может быть создана ResourceManager локализованное имя.

Answer 2

У меня была проблема с локализацией значений enum некоторое время назад, я не уверен, что она отвечает на ваш вопрос, но, по крайней мере, дает вам другой подход, который нужно иметь в виду.

Началось с создания моего собственного атрибута Localizing

/// <SUMMARY>
/// Attribute used for localization. Description field should contain a reference to the Resource file for correct localization
/// </SUMMARY>
public class LocalizationAttribute : Attribute
{
    public LocalizationAttribute(string description)
    {
        this._description = description;
    }

    private string _description;
    /// <SUMMARY>
    /// Used to reference a resource key
    /// </SUMMARY>
    public string Description
    {
        get
        {
            return this._description;
        }
    }
}

Оттуда я создаю сам enum

[TypeConverter(typeof(EnumToLocalizedString))]
public enum ReviewReason
{
    [LocalizationAttribute("ReviewReasonNewDocument")]
    NewDocument = 1,


    [LocalizationAttribute("ReviewReasonInternalAudit")]
    InternalAudit = 2,


    [LocalizationAttribute("ReviewReasonExternalAudit")]
    ExternalAudit = 3,


    [LocalizationAttribute("ReviewReasonChangedWorkBehaviour")]
    ChangedWorkBehaviour = 4,


    [LocalizationAttribute("ReviewReasonChangedWorkBehaviourBecauseOfComplaints")]
    ChangedWorkBehaviourBecauseOfComplaints = 5,


    [LocalizationAttribute("ReviewReasonMovedFromOlderSystem")]
    MovedFromOlderSystem = 6,


    [LocalizationAttribute("ReviewReasonPeriodicUpdate")]
    PeriodicUpdate = 7,


    [LocalizationAttribute("ReviewReasonDocumentChanged")]
    DocumentChanged = 8
}

Затем я создал конвертер типов, который будет извлекать ключ описания LocalizationAttribute и получать доступ к файлу ресурса, чтобы получить локализацию (описание атрибута должно соответствовать ключу ресурса :))

public class EnumToLocalizedString : TypeConverter
    {
        public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
        {
            return (sourceType.Equals(typeof(Enum)));
        }

        public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType)
        {
            return (destinationType.Equals(typeof(String)));
        }

        public override object ConvertFrom(ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value)
        {
            return base.ConvertFrom(context, culture, value);
        }

        public override object ConvertTo(ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value, Type destinationType)
        {
            if (!destinationType.Equals(typeof(String)))
            {
                throw new ArgumentException("Can only convert to string.", "destinationType");
            }
            if (!value.GetType().BaseType.Equals(typeof(Enum)))
            {
                throw new ArgumentException("Can only convert an instance of enum.", "value");
            }

            string name = value.ToString();
            object[] attrs = value.GetType().GetField(name).GetCustomAttributes(typeof(LocalizationAttribute), false);
            if (attrs.Length != 1  !(attrs[0] is LocalizationAttribute))
            {
                throw new ArgumentException("Invalid enum argument");
            }
            return Handbok.Code.Resources.handbok.ResourceManager.GetString(((LocalizationAttribute)attrs[0]).Description);
        }
    }

Наконец, я создал клиент, который использует TypeConverter, который в данном случае является коллекцией

public class ReviewReasonCollection
{
    private static Collection<KEYVALUEPAIR<REVIEWREASON,>> _reviewReasons;

    public static Collection<KEYVALUEPAIR<REVIEWREASON,>> AllReviewReasons
    {
        get
        {
            if (_reviewReasons == null)
            {
                _reviewReasons = new Collection<KEYVALUEPAIR<REVIEWREASON,>>();
                TypeConverter t = TypeDescriptor.GetConverter(typeof(ReviewReason));

                foreach (ReviewReason reviewReason in Enum.GetValues(typeof(ReviewReason)))
                {
                    _reviewReasons.Add(new KeyValuePair<REVIEWREASON,>(reviewReason, t.ConvertToString(reviewReason)));
                }
            }
            return _reviewReasons;
        }
    }
}

Я изначально разместил это решение в своем блоге . Надеюсь, это поможет вам:)

Answer 3

Проблема с предложенным вами способом заключается в том, что будет сложно обновить переводы, и для этого может потребоваться даже программист. Кроме того, как вы собираетесь обновлять переводы без обновления всего приложения?

Я сделал много переведенных приложений, и у меня есть отдельный текстовый файл с переводами, сформированный примерно так:

[английский]
Done = Done

[Норвежский]
Совершено = Ferdig

И у меня есть функция TranslateForm (), которую я вызываю внутри события Form Show, которая будет транслировать все элементы пользовательского интерфейса. Функция TranslateForm () будет иметь такие вещи, как

buttonDone.Text = Translate.GetTranslation("Done");

Последняя часть с TranslateForm не является оптимальным решением, я думаю, что со временем я перейду к решению, где сам элемент управления вызывает класс Translate. Преимущество использования этой системы в том, что она проста для программиста, у вас могут быть другие переводы с добавлением лицензии без необходимости выполнять ручную работу впоследствии (это важно для меня, так как у меня есть переводы сообщества), поэтому они часто обновляются не хочу тратить на это время. Я также могу обновлять переводы во время работы приложения, без необходимости перезапуска или обновления приложения.