清理ios專案無用的圖片資源

姜家志發表於2016-04-03
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使用起來更方便，更快，更簡單,專案地址：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 = `
`.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

相關文章