开发Android studio 插件:项目国际化与Excel文
开发一个将Android项目的国际化资源与Excel表格互导的插件
功能说明
当一个项目从非国际化(只有单言语类型)转向国际化(多语言支持)亦或项目过于庞大Module数量众多每期迭代都需要从各个Module抽取和填补翻译时就会有了个很烦恼的事情,这么多的语言资源靠手动整理那得到猴年马月,等整理完也练就了一双麒麟臂了。(以上纯属抱怨可忽略)😄
言归正传,如同以上机械式工作作为一名程序猿当然是交给程序去处理喽,所以需要写一个能够遍历读取识别并提取项目中的语言资源文件,并将资源导出成Excel文件以方便交给其他工具人(手动狗头)进行翻译的脚本,翻译完成后还需要将Excel文件转换成项目中的资源格式并原路存储进去。为了更加方便的在各个项目中使用当然还是把上面写的脚本套上Intellij plugin的皮囊一起食用更佳。
支持功能:
- 将项目的res->values-xx-> strings.xml资源导出至excel文件(请勿修改表格的格式)
- 将excel文件文件中的资源导回至项目中(资源会原路径写入)
- 支持导出资源时自动在线翻译缺失的语言类型资源,并写入Excel中。(在线翻译使用的百度API,大量翻译可能会限制IP)
- 支持将Excel导回项目中时自动补全缺失的语言资源,以Excel中已存在的资源为准。
- 支持Excel导回项目时对资源中的 占位符进行修正,eg:(% S,s%,% D d%)修正 (%s,%d)。一般这种异常占位符由机器翻译引起。
- 支持自定义选择导入\导出Module
- 支持自定义选择导入\导出语言类型
- 支持导入时自动创建缺失的语言类型对应的资源文件以及文件夹
- 支持数组类型资源
- 支持导出的资源使用颜色高亮状态新增覆盖异常
Tip:当前插件v1.0.1版本未经过大量测试,所以使用前务必先提交项目代码,以防不必要的损失。
安装使用方式
- 安装插件
- 在线安装
在线搜索 "LangResExport"
image.png
- 离线安装
插件jar包下载地址:https://github.com/LucasDevelop/LangTransExcel/blob/master/LangTransExcel-V1.0.1.zip
image.png
使用本地安装,随后重启IDE。
- 启动插件
打开Android stuido 菜单栏Tools->Android Lang Transform Exce
选择模式
image.png
点击OK后开始扫描项目中的资源。
image.png
导出:导出项目中国际化翻译资源到Excel表格
等待扫描结束后开始配置参数,参数会根据扫描项目的结果自动列出一存在的module和语言类型。可自行选择需要导出的module和语言类型。
image.png
配置完成点击OK,等待导出结果。
image.png
导入:将Excel表格中的资源导入到项目中
等待扫描结束后开始配置参数
<font color='red'>Tip:默认语言语种指的是values/strings.xml中语言类型</font>
点击OK等待导入完成即可。
- 查看导出的Excel文件
如果配置时选择的是文件夹那么生成Excel 文件为【国际化翻译.xls】固定名称。剩下的就是翻译的事情了。
插件开发流程
- 安装Intellij idea
下载地址:https://www.jetbrains.com/idea/ 安装最新的版本即可
- 新建一个Plugin项目
image.png选择Gradle项目以方便依赖三方lib,并且勾选java/Intellij Platfrom Plugin, kotlin是否勾选看个人开发语言习惯。然后下一步。
image.png填写项目名称以及地址
- 配置插件信息
- 创建java文件夹
- 配置Gradle
image.png如果插件要可安装在最近android studio版本请务必配置红框内容,否则会导致无法安装在Android studio上。
intellij {
version = '2020.1' // 因为Android Studio 4.1是基于IDEA 2020.1 Community版本开发的,所以这里调试也指定为此版本
plugins = ['android']
}
patchPluginXml {
changeNotes = """
V1.0.0:实现基本双向导入功能.
<em></em>"""
sinceBuild = '191' // 插件适用的IDEA版本范围,此范围基本涵盖了Android Studio最近两三年的版本
untilBuild = '212.*'
}
- 创建插件入口,也就是为啥插件会在Tools->Android Lang Transform Excel上
- 创建弹窗。
image.png创建完弹窗后可看到以下界面,最右侧可选择控件并拖动到中间的布局中。
- 运行插件,查看效果
image.png等待编译结束后会自动新开一个Idea程序窗口,在新开的窗口创建一个新项目或者选择一个项目进入。在新开的Idea窗口中找到我们的插件并打开。
最后效果如下:
image.png- 打包插件并安装在android studio上
image.png打开右侧Gradle任务栏,运行buildPlugin
image.png等待编译结束后在build中找到我们的插件包
image.png在Android studio中选择本地安装我们的插件,然后重启Android studio即可。
当然,我们也可以把插件发布到官网仓库然后供其他人安装使用,具体方式大家各自查找吧,这里不讲解了。
国际化资源与Excel互导脚本开发
image.png主要是基于poi和dom4j的API进行文件操作,API 对应的Gradle依赖如下
implementation group: 'org.apache.poi', name: 'poi', version: '3.9'
// https://mvnrepository.com/artifact/org.dom4j/dom4j
implementation group: 'org.dom4j', name: 'dom4j', version: '2.1.1'
implementation group: 'jaxen', name: 'jaxen', version: '1.2.0'
具体文件查找Excel读取/写入实现代码已上传至gayhub,在下就不在这里指指点点了。相信各位大佬对于这种级别的API还是能把握住的。