前言
在开发OC项目的时候,我们经常会用到第三方库。比如,我们会导入AFNetworking进行网络请求,或者使用Masonry进行布局约束等。随着项目的变大和开发人员的变多,在项目规范和格式上就会变得越来越差,为了规范代码风格和格式,一般小组内部都会有专题进行代码规范的讨论。但是难免有一些遗漏,比如未按照wwdc推荐的方式进行第三方库合理的导入(#import <A/A.h>)。
我们知道,在引入其他三方库的时候一般使用#import <库名/类型.h>
的方式进入导入。至于为什么使用这样的方式导入呢,一是为了明确头文件的由来,避免问题,另一方面是我们在是否开启Clang Module
的时候,随意切换。
那怎么解决上述import的问题呢,下面我将介绍一款使用Python开发的小工具,解决上述提出的问题。
项目介绍
本项目是使用Python开发的一款小工具,只需要运行main.py
文件后,选择想要修改的项目,就可以全局替换项目中的.h\.m文件三方库导入问题。
运行后可以看到如下结果:
#import "Masonry.h" // 未处理的的import方式
#import <Masonry/Masonry.h> // 处理后的import方式
实现原理:
1.遍历Pods路径下的文件,生成一个{'三方库/A.h', '三方库/B.h'.....}这中格式的数组。下面我摘一些关键代码进行介绍
for dir_name in files:
if os.path.isdir(dir_path):
dot_h_array = []
for _, _, files in os.walk(dir_path):
for file in files:
if file.endswith('.h'):
dot_h_array.append(file)
pods_dot_h[dir_name] = dot_h_array
# 重新整理pods_dot_h字典,将字典转为{'xx.h'=>'pod名称/xx.h'}这样的格式字典
for key in pods_dot_h:
for value in pods_dot_h[key]:
pods_import[value] = f"{key}/{value}"
这里大概实现两步,
- 遍历Pods下的一个文件夹,比如
AFNetworking
路径,然后创建了一个类似:AFNetworking = {'AFSecurityPolicy.h', 'AFURLSessionManager.h'...}样式的字典 - 在
pods_import[value] = f"{key}/{value}"
这一行将AFNetworking
中的类进行格式转换,实现一个类似于{AFSecurityPolicy.h = "AFNetworking/AFSecurityPolicy.h"...}这样的数组
这样做的意义主要是方便之后在遍历.h\.m文件中的遇到 AFSecurityPolicy.h
类时,我们可以很轻松的其替换成 AFNetworking/AFSecurityPolicy.h
2.遍历项目中的.h\.m,使用正则匹配#import "类名.h"
这样的导入方式,并获得当前导入的类名.h
,如果当前类名是在上述返回的集合中,则将当前导入改成import尖括号的方式导入
import_dot_hfile = re.compile(r'#import[\s]*["|<][\w\.\+]+\.h["|>]')
dot_hfile = re.compile(r'[\w]+[\w\.\+]+\.h')
for line in finput:
match = import_dot_hfile.search(line)
if match:
old_str = match.group()
import_name = dot_hfile.search(old_str).group()
if import_name in pods_import:
new_str = f"#import <{pods_import[import_name]}>"
line = line.replace(old_str, new_str)
sys.stdout.write(line)
大概实现三步:
- 使用正则
import_dot_hfile
对一个文件的每一行进行遍历,如果匹配import "类名.h"
,我们就使用正则获得该行所导入的类名.h
- 根据使用的
类名.h
,从pods_import
找到包含三方库名的全拼,并包装成#import <库名/类名.h>
格式的新行字符串 - 使用新的字符串替换当前行内容,并写入文件
项目
项目地址为:https://github.com/xiaofeixia9/ImportTool
小结
其实Python的作用远不止本章,除了之前在Python环境配置介绍的功能外,我自己在iOS开发中也遇到了将接口文档转.h\.m Model文件、对Excel进行解析等需求,这大大简化了人工检索的需要的时间,提高了开发效率。