资讯专栏INFORMATION COLUMN

批量修改OC类名脚本 -- python

cc17 / 994人阅读

摘要:前言近日由于种种原因,需要把代码里面的类全部都修改一遍类名。并且在给类文件重命名的时,需要注意前缀和后缀添加的位置,不要添加到和后面去了即可。

前言

近日由于种种原因,需要把代码里面的类全部都修改一遍类名。

在网上找了一圈相关的开源库,没有发现有合适满意的,始终都存在一些问题,要么出现误修改,要么把方法名或者属性名也给修改了等等情况。

于是决定掏出生疏的Python来写一个。

批量修改类名需要解决四个问题:

如何取得需要修改的类名?

如何修改文件中出现的类名并且不会出现误改等情况?

如何修改文件名?

修改文件名后,如何同步修改project.pbxproj里面的文件名信息?

问题一、如何取得需要修改的类名?
想法A:

</>复制代码

  1. 由于自己前不久写了一个获取target对应的编译以及资源文件的工具MacPbxprojHelper,利用其来获取到target对应的类名写入文件,然后用python来读取文件获取到需要修改的类名,实时上第一版我也是这么做的,但是不够优雅,明明一个脚本能解决的事,为什么需要那么多步操作呢?
想法B:

</>复制代码

  1. 利用python直接遍历文件夹获取类名,没错就决定是你了。
    其实用python遍历文件实现起来特别简单快捷。但是其中也有可能存在的问题,例如我们的项目中包含有部分资源文件,而资源文件的后缀名是不定的,但是实际我们只需要.m以及.mm结尾的文件前缀作为我们的类名,当然其中包含有类目也需要过滤掉。并且考虑到我们具备一些特殊的需求,需要过滤某些文件甚至某些文件夹下的文件等等。我这边的脚本都有考虑到

实现代码如下:

</>复制代码

  1. def getClassNames(filepath):
  2. #读取文件名入数组
  3. #过滤文件夹
  4. filterDirs = ["ThirdKit/","小说/"]
  5. #过滤文件
  6. filterFiles = []
  7. classNames = []
  8. #遍历filepath下所有文件,包括子目录
  9. for root, dirs, files in os.walk(filepath):
  10. for name in files:
  11. path = os.path.join(root, name)
  12. #过滤文件夹
  13. isFilterDir = 0
  14. for filterDir in filterDirs:
  15. if filterDir in path:
  16. isFilterDir = 1
  17. break
  18. if isFilterDir != 1:
  19. if ".m" in name:
  20. splitNames = name.split(".m")
  21. #只选择.m.mm结尾的文件
  22. if splitNames[1] == "" or splitNames[1] == "m":
  23. cn = splitNames[0]
  24. #过滤文件
  25. isFilterFile = 0
  26. for ff in filterFiles:
  27. if ff == cn:
  28. isFilterFile = 1
  29. if isFilterFile != 1:
  30. #过滤类目
  31. if cn.find("+") == -1:
  32. print(cn)
  33. classNames.append(cn)
  34. return classNames
问题二、如何修改文件中出现的类名并且不出现误改的情况?

在我搜集到的开源的脚本中,有极大比例的一部分是直接通过类名替换,其实这特别容易出现误改。比如我有一个类名为ABC,一个类名为AB,那么ABC就可能出现被修改两次的情况。所以我这边就采用笨办法,先敲定类名出现的场景,根据其场景设定规则,只有出现类名出现在这些规则中时,才去替换,这样就可以保证100%的正确率。(这也是大坑,因为不同的程序员书写习惯的问题,导致规则的定义实际极度繁琐,而且会出现部分遗漏,每一次遗漏后,我都需要添加规则再重跑来验证··)

</>复制代码

  1. 下面就是这个脚本最大的贡献·· 自认为基本涵盖完了类名的出现场景(如果有没有涵盖的,请记得一定联系我!!),一共37种规则,运用这37种规则,做到了一次脚本,既完美修改,无需在动代码就可以直接运行并且不会有闪退问题··

</>复制代码

  1. #一开始构思了 14个 后来....
  2. rule_1 = """ + cn + "." #引用修改
  3. rule_2 = """ + cn + """ #类名被直接使用
  4. rule_3 = ":" + cn + " " #继承 后续有空格
  5. rule_4 = ":" + cn + "
  6. " #类名后面是换行
  7. rule_5 = " " + cn + "<"
  8. rule_6 = " " + cn + "
  9. " #类名后面是换行
  10. rule_7 = " " + cn + " "
  11. rule_8 = " " + cn + "("
  12. rule_9 = "[" + cn + " "
  13. rule_10 = "[" + cn + "*"
  14. rule_11 = "(" + cn + "*"
  15. rule_12 = ")" + cn + "*"
  16. rule_13 = " " + cn + "*"
  17. rule_14 = " " + cn + "
  18. "
  19. rule_15 = "(" + cn + " "
  20. rule_16 = " " + cn + ";"
  21. rule_17 = "," + cn + " "
  22. rule_18 = "," + cn + "*"
  23. rule_19 = ")" + cn + " "
  24. rule_20 = "," + cn + ";"
  25. rule_21 = " " + cn + ","
  26. rule_22 = "<" + cn + "*" #被当做协议 遵守类
  27. rule_23 = "<" + cn + " "
  28. rule_24 = "," + cn + ","
  29. rule_25 = " " + cn + ":"
  30. rule_26 = ":" + cn + "//" #后面跟注释的、、我TM。。
  31. rule_27 = " " + cn + "//"
  32. rule_28 = " " + cn + "{" #后面跟大括号的··
  33. rule_29 = ")" + cn + "<" #为什么遵守协议 也用了 实际类名 没有用ID
  34. rule_30 = "(" + cn + "." #为什么类要使用.语法
  35. rule_31 = " " + cn + "." #类名调用.语法
  36. rule_32 = "!" + cn + "."
  37. rule_33 = ":" + cn + "." #类名调用点语法 被当做参数传入
  38. rule_34 = "[" + cn + "
  39. " #类名被换行
  40. rule_35 = ":" + cn + "<" #继承类名后面 直接接入协议 默认实际是不存在这个问题的
  41. rule_36 = """ + cn + "_" #类取名有下划线以及数字 以及通过工厂用数字来创建的情况
  42. rule_37 = """ + cn + "%" #类取名有数字 以及通过工厂用数字来创建的情况
问题三、如何修改文件名?

这个问题其实很好解决,利用python的os库就可以直接rename,只是需要拼接全路径。并且在给类文件重命名的时,需要注意前缀和后缀添加的位置,不要添加到.h和.m后面去了即可。

问题四、如何同步修改project.pbxproj里面的文件信息?

这里又和第二个问题一样需要定义一定规则,才能确保不会出现误替换,但是这个规则和上面比起来简直是小巫见大巫。规则如下:

</>复制代码

  1. def pbRule(cn):
  2. rule_1 = "=" + cn + "."
  3. rule_2 = " " + cn + "."
  4. rule_3 = "/" + cn + "."
  5. rule_4 = """ + cn + "."

</>复制代码

  1. 以上,问题都解决了。
使用方式

</>复制代码

  1. ----------脚本说明----------
  2. 脚本用于批量修改类名
  3. 脚本可传入四个参数
  4. 1、待处理的文件路径. example-->"./KanManHua"
  5. 2、待修改的pbxproj文件地址 example-- >"./KanManHua.xcodeproj/project.pbxproj"
  6. 3、类名前缀 example-->"MHT_"
  7. 4、类名后缀 example-->"_MHT"
  8. 其中前三个参数为必传参数 划重点,要考
  9. ----------请开心使用---------
  10. 另脚本支持 -h --help 操作

当参数错误时,也有对应提示以及上述帮助信息

正常使用

示例:

</>复制代码

  1. python changeClassName.py ./KanManHua ./KanManHua.xcodeproj/project.pbxproj MHT_ _MHT
helpinfo获取

示例:

</>复制代码

  1. python changeClassName.py
  2. python changeClassName.py -h
  3. python changeClassName.py --help
脚本地址 后记

由于我司还有需求修改指定 target的类名,实际也有一套可以仅仅只修改target类名的方法,但是由于使用要复杂一点,首先要提取target对应的编译类,再使用脚本来修改,修改使用到我之前发布的一个工具类MacPbxprojHelper,如有需要的话请和我联系。
联系方式:357863248@qq.com

MacPbxprojHelper介绍链接

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/42859.html

相关文章

  • Redis开发学习

    摘要:语法命令基本语法实例数据类型支持五种数据类型字符串,哈希,列表,集合及有序集合。资源修改文件增加如下内容如果在集成环境的目录下安装完成后重启或。 Redis 简介 Redis 是完全开源免费的,遵守BSD协议,是一个高性能的key-value数据库。Redis 与其他 key - value 缓存产品有以下三个特点: Redis支持数据的持久化,可以将内存中的数据保持在磁盘中,重启的...

    ccj659 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<