规范OC import导入

前言

在开发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进行解析等需求,这大大简化了人工检索的需要的时间,提高了开发效率。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,377评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,390评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,967评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,344评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,441评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,492评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,497评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,274评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,732评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,008评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,184评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,837评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,520评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,156评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,407评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,056评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,074评论 2 352

推荐阅读更多精彩内容