美文网首页iOS 好文iOSiOS学习记录
清理ios项目无用的图片资源

清理ios项目无用的图片资源

作者: 姜家志 | 来源:发表于2016-09-03 11:01 被阅读2897次

    项目经过需求的变更,产品迭代,再多次的改版之后,有些不再使用的图片不一定能够及时的清理掉,这些无用的图片一方面让项目图片资源的结构更加的复杂,另一方面会导致ipa包的体积变大。
    及时的清理掉不用的图片资源很有必要,在Android项目中使用Lint可以轻松的完成这个任务,而在ios上没有找到比较好的清理无用图片的工具。
    参考网上的例子,写了一个python清除ios项目中无用的图片资源的脚本。首先介绍下ios中使用图像资源的方式。

    Images Assets

    ios中使用 Images Assets管理图片,项目的图片资源一般都放在这Image Assets里面,图片会放到*.imageset目录里,对应的有1x,2x3x的图,还有一个Contents.json的描述文件。 清除图片资源需要把*.imageset清除掉,包括图片文件和json文件。 想要清除掉不用的图片资源,就需要知道图片资源怎么被引用的,再查找到未被引用的图片资源就可以清除掉了。
    ios代码中调用图片的方法一般是:

    [UIImage imageNamed:@"image"]

    xib中调用图片的方法是用xml的方式描述,图片资源作为image的名称:

     <imageView  image="image" id="Rb9-sl-eQM">                
     </imageView>
    

    因此清理的思路就是搜索项目中的图片文件,如果找到对于的"name"xib或者ios代码中存在,说明该图片被使用了,不然的话该图片即可被清理掉。
    先看看如何方便的搜索图片文件有没有被使用吧!

    搜索文件

    搜索文件的方式可以使用grep,ack都是不错的工具,但是有一种更快,更好的搜索文件内容的方式:The Silver SearcherThe Silver Searcher使用起来更方便,更快,更简单,项目地址:https://github.com/ggreer/the_silver_searcher。 直接安装The Silver Searcher的命令:

    brew install the_silver_searcher

    使用ag命令就可以进行文本搜索:

    ag "image" './'

    这个命令的意思是搜索到该目录下以及其子目录下的所有含有"image"的文件。
    使用这个命令就需要在python中执行bash命令。

    bash命令

    使用bash命令来进行一些搜索文本,删除文件的工作,在python中可以直接运行bash命令。 在python中直接使用bash命令:

    os.popen('echo $PATH')

    在执行bash命令的时候,可以通过os.popen('echo $PATH').read()执行并读取执行的结果。 也可以直接执行bash命令不用关系执行的结果,例如:

    os.system('rm -rf dir')

    需要用到的bash命令有ag "image" './'rm -rf './',前者用来搜索文本有没有被使用,后者用来删除文件夹。
    下面就看下完整的实现。

    清除无用的imageset资源

    完整的清理无用的图片资源的代码:

    path = 'ios'
    images = glob.glob('ios/images.xcassets/*/*.imageset')
    def find_un_used():
        img_names = [os.path.basename(pic)[:-9] for pic in images]
        unused_imgs = []
        for i in range(0, len(images)):
            pic_name = img_names[i]
            command = 'ag "%s" %s' % (pic_name, path)
            result = os.popen(command).read()
            if result == '':
                unused_imgs.append(images[i])
                print 'remove %s' % (images[i])
                os.system('rm -rf %s' % (images[i]))
    
    
        text_path = 'unused.txt'
        tex = '\n'.join(sorted(unused_imgs))
        os.system('echo "%s" > %s' % (tex, text_path))
        print 'unuse res:%d' % (len(unused_imgs))
        print 'Done!'
    
    

    这段代码是从当前文件夹里,遍历所有的.imageset文件,找到图片使用的图片名称,在文件夹中搜索该名称的文件有没有被使用。如果没有被使用的名称就可以清除掉该资源。
    执行这段之后发现有一些不应该清除图片资源也被清除了,这里有个例外的情况没有考虑到。

    ignores

    有时候会给一些资源文件动态的赋值,使用这样的代码:

    for (int i = 1; i <= 10; ++i) {
        NSString *imageName = [NSString stringWithFormat:@"image_%d", i];
        UIImage *image = [UIImage imageNamed:imageName];
        ......
    }
    

    上面的代码中查找 image1时,发现这个图片并没有使用,该图片资源就会被清除掉,但是该图片在项目中是动态赋值的并不应该被清除。
    我采用ignore的方式来解决这个问题,也就是先提前准备好一个ignore的列表,内容采用正则表达式来定义,被匹配到的文件资源就不进行清除处理,例如ignores为:

    ignores = {r'image*\d+'}

    然后在定义一个检查ignores的方法:

    def is_ignore(str):
        for ignore in ignores:
            if re.match(ignore, str):
                return True
        return False
    

    如果一个文件名在ignores中出现就会忽略该文件的清理检查,这样就不会清理掉一些动态赋值的图片资源了。
    源码地址:https://github.com/jjz/script/blob/master/un_used.py

    请自行设置好目录,执行命令:

    python un_used.py

    相关文章

      网友评论

      • 风已逝云:写的很好,不过有时候执行效果没有预期那么好,做了一个尝试,新加入的图片是能够扫描出来,但是不会执行删除操作
      • Jabir_Zhang:用了,结果把xib里用的也都给删了啊,不是很准确啊
      • 无神:我经过一番折腾,安装了系统插件,调试了一下,目前已经不报错,且正常打印log了,倒是木有达到预期的效果,而是把存放image资源目录下的所有图片都删除了,求帮助?@姜家志@我是乔忘记疯狂
      • 我是乔忘记疯狂:思路不错,不过试用了下脚本并不好用。
        https://github.com/jjz/script/blob/master/un_used.py#L20
        感觉用 `result == ''` 来做判断貌似不合理
        宋鸿康iOS:@姜家志 朋友留个联系方式问问
        姜家志:@没故事的宋同学 这个是Python代码,直接运行就可以了
        宋鸿康iOS:@我是乔忘记疯狂 这东西怎么玩啊? 留个联系方式教我下拉

      本文标题:清理ios项目无用的图片资源

      本文链接:https://www.haomeiwen.com/subject/ezmkettx.html