清理 iOS 項目無用的圖片資源

項目通過需求的變動，產品迭代，再屢次的改版以後，有些再也不使用的圖片不必定可以及時的清理掉，這些無用的圖片一方面讓項目圖片資源的結構更加的複雜，另外一方面會致使ipa包的體積變大。
及時的清理掉不用的圖片資源頗有必要，在Android項目中使用Lint能夠輕鬆的完成這個任務，而在ios上沒有找到比較好的清理無用圖片的工具。
參考網上的例子，寫了一個python清除ios項目中無用的圖片資源的腳本。首先介紹下ios中使用圖像資源的方式。

Images Assets

ios中使用 Images Assets管理圖片，項目的圖片資源通常都放在這Image Assets裏面，圖片會放到*.imageset目錄裏，對應的有1x,2x和3x的圖,還有一個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 Searcher，The Silver Searcher使用起來更方便，更快，更簡單,項目地址：github.com/ggreer/the_…。 直接安裝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中出現就會忽略該文件的清理檢查，這樣就不會清理掉一些動態賦值的圖片資源了。
源碼地址：github.com/jjz/script/…

請自行設置好目錄，執行命令：

python un_used.py