多语言框架设计

为新项目增加一个多语言框架

通过在Text 组件下增加一个Language.cs 组件来配置多语言Key 。

在Editor 文件夹中增加一个SetPropertyDrawer.cs 脚本来解析 SerializeField(用于将私有属性序列化到Inspector 界面编辑) 中的SetProperty() ，这样可以在Editor 修改时，触发Language.cs中的Get/Set 方法来实时的修改Text 组件的值，得到跟运行时一致的效果。

/*
@FileName: Language
@Date:     2018-07-16 07/16/18
@Author:   Logen
@Description:
    多语言组件，通过添加该组件到Text来实现多语言配置
*/

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;
using UnityEditor;
using System;

[DisallowMultipleComponent]
[RequireComponent(typeof(Text))]
public class Language : MonoBehaviour {
    public Text LangText;
    //多语言 Key ，值在lua 中获取设置
    [SerializeField, SetProperty("LangKey")]
    private string _langKey;
    public string LangKey{
        get {return _langKey;}
        set {
            _langKey = value;
            if(!LangText){
                LangText = this.GetComponent<Text>();
            }
            LangText.text = value;
        }
    }

    // 根据枚举的值解析，并设置对应的属性，达到样式的效果，以“_”分割。
    // 【0】字体样式（FontStyle）
    // 【1】字体大小（FontSize）
    // 【2】字体间距（LineSpacing）
    // 【3】字体颜色（Color FF(a)FF(r)FF(g)FF(b)） 
    //  [...] 还可以加属性
    public enum TextStyleEnum{
        Normal_30_1_50FF0000,
        Bold_25_2_FF00FF00
    }

    // 字体样式，通过配置样式枚举，可以快速设置字体属性，未来修改也可以快速修改样式来修改所有表现
    [SerializeField, SetProperty("TextStyle")]
    private TextStyleEnum _textStyle;
    public TextStyleEnum TextStyle{
        get {return _textStyle;}
        set {
            _textStyle = value;
            if(!LangText){
                LangText = this.GetComponent<Text>();
            }
            string  enumString  =  Enum.GetName( typeof (TextStyleEnum), value);//推荐
            string[] enumArr = enumString.Split(new char[1]{'_'});
            this.setFontStyle(LangText,enumArr[0]);
            this.setFontSize(LangText,enumArr[1]);
            this.setLineSpacing(LangText,enumArr[2]);
            this.setFontColor(LangText,enumArr[3]);
        }
    }

    private void setFontStyle(Text m_Text,string fontStyleStr){
        if(fontStyleStr == "Normal"){
            m_Text.fontStyle = FontStyle.Normal;
        }else if(fontStyleStr == "Bold"){
            m_Text.fontStyle = FontStyle.Bold;
        }else if(fontStyleStr == "Italic"){
            m_Text.fontStyle = FontStyle.Italic;
        }else{
            m_Text.fontStyle = FontStyle.BoldAndItalic;
        }
    }

    private void setFontSize(Text m_Text,string sizeStr){
        var fontSize = int.Parse(sizeStr);
        m_Text.fontSize = fontSize;
    }

    private void setLineSpacing(Text m_Text,string lineSpacingStr){
        var lineSpacing = int.Parse(lineSpacingStr);
        m_Text.lineSpacing = lineSpacing;
    }

    private void setFontColor(Text m_Text,string colorStr){
        Color c = this.hexToColor(colorStr);
        m_Text.color = c;
    }

    private Color hexToColor(string hex){
        byte DEC_a = byte.Parse(hex.Substring(0, 2), System.Globalization.NumberStyles.HexNumber);
        byte DEC_r = byte.Parse(hex.Substring(2, 2), System.Globalization.NumberStyles.HexNumber);
        byte DEC_g = byte.Parse(hex.Substring(4, 2), System.Globalization.NumberStyles.HexNumber);
        byte DEC_b = byte.Parse(hex.Substring(6, 2), System.Globalization.NumberStyles.HexNumber);
        //Debug.Log("DEC_r"+ DEC_r + "DEC_g"+ DEC_g+ "DEC_b"+ DEC_b);
        float r = DEC_r / 255f;
        float g = DEC_g / 255f;
        float b = DEC_b / 255f;
        float a = DEC_a / 255f;
        return new Color(r, g, b, a);
    }


    void Start () {
        
    }

    void Update()
    {

    }
}

BaseView 初始化后，获取Language组件中Text 组件和 LangKey ，再根据lua 表中配置的多语言找到对应LangKey 来赋值。

-- 模块加载创建完成时调用
function BaseView:onInitialize()
    -- 初始化所有多语言配置
    local langComps = self.view:GetComponentsInChildren(typeof(CS.Language),false)
    if langComps and langComps.Length > 0 then
        local langComp
        for i = 0,langComps.Length - 1 do
            langComp = langComps[i]
            if langComp.LangText then
                LanguageManager:SetValue(langComp.LangText)
            end
        end
    end
  self:onEnter()
end

Language 组件配置如下图：

image.png

为何采用TextStyle这种样式的配置，是为了方便编辑UI 的同学，可以根据美术要求新加样式，实现一键配置Text组件。也是同样为了方便后续其他地区统一修改样式。而不用一一找出对应Text 修改。
文本样式枚举如下：

    // 根据枚举的值解析，并设置对应的属性，达到样式的效果，以“_”分割。
    // 【0】字体样式（FontStyle）
    // 【1】字体大小（FontSize）
    // 【2】字体间距（LineSpacing）
    // 【3】字体颜色（Color FF(a)FF(r)FF(g)FF(b)） 
    //  [...] 还可以加属性，暂时只加了四种通用的，后续可以扩展下。
    public enum TextStyleEnum{
        Normal_30_1_50FF0000,
        Bold_25_2_FF00FF00
    }

参考：
Unity3D研究院之Inspector视图中的get/set使用（四）
第二种方法之Inspector视图中的get/set使用

多语言框架设计

推荐阅读更多精彩内容