隨著版本不斷迭代,App 體積越滾越大,項目裡沉澱下來的無用圖片也越來越多。這些資源會直接推高下載成本,用流量的用戶尤其敏感,所以定期清理很有必要。我用 Python 寫了個腳本來做這件事,原理很樸素:find 加 grep 的組合。下面說說實現過程。
我們手動判斷一張圖有沒有用到,做法是在 Xcode 裡按 Shift + Command + F 全局搜索圖片名,看有沒有引用。這一步可以用 grep 命令替代。
於是思路就出來了:用 find 找出所有後綴為 .png、.jpg、.jpeg、.gif 的文件,取出不帶後綴的文件名(比如 a.png 取 a),存進一個 set 裡去重(因為同一張圖會有 @2x、@3x 多個版本);然後從 set 中逐個取出關鍵字,在項目路徑下執行 grep -w 做單詞匹配,有結果就說明這個關鍵字被用到過。
有兩個目錄要特殊處理:/AppIcon.appiconset 和 /LaunchImage.launchimage。這兩個是項目配置直接引用的圖片,grep 匹配不到,必須提前過濾掉,不能加進待檢查列表。
grep 是關鍵字匹配,所以一張名叫 message 的圖被匹配到,只能說明項目裡某個文件包含 message 這個詞,不一定真的用了這張圖。但反過來是成立的:如果所有文件都不包含這個關鍵字,那它一定沒被使用。
如果圖片名通過宏定義,而這個宏本身已經沒人用了,會被誤判為「使用中」而漏掉;同理,曾經用過但已被註釋掉的代碼,也會因為關鍵字仍存在而被漏判。
搜索範圍可以收窄,只掃 .h、.m、.mm、.xib、.swift、.storyboard 這幾類文件。
Python 和 shell 交互時,路徑帶空格兩邊行為不一致,解法是用引號把路徑包起來,例如 'path'。
我用的是 Python,寫法還是 Objective-C 的風格,如果你有更好的實現,歡迎一起討論。
#!/usr/bin/python
# -*- coding: utf-8 -*-
import os, sys
import subprocess
import shlex
import shutil
import time
__author__ = 'xieguobi'
exclude_AppIcon = 'AppIcon.appiconset'
exclude_LaunchImage = 'LaunchImage.launchimage'
project_dir = "/your_path"
back_not_used_dir = "/your_path"
auto_delete = 0
auto_move = 0
def find_exclude_images():
exclude_images_set = set()
command = "find '{0}' -type d -name {other}".format(project_dir, other = exclude_AppIcon)
s = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
result = s.communicate()
if len(result) > 0:
exclude_path = result[0]
for type in support_types():
exclude_images_set = exclude_images_set | do_find_command(exclude_path, type)
command = "find '{0}' -type d -name {other}".format(project_dir, other = exclude_LaunchImage)
s = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
result = s.communicate()
if len(result) > 0:
exclude_path = result[0]
for type in support_types():
exclude_images_set = exclude_images_set | do_find_command(exclude_path, type)
return exclude_images_set
def do_find_command(search_dir, file_type):
if len(search_dir) == 0 or len(file_type) == 0:
return set()
search_dir = search_dir.replace('\n','')
all_names_set = set()
command = "find '{}' -name '*.{other}' 2>/dev/null".format(search_dir, other = file_type)
s = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
results = s.communicate()[0].split()
for name in results:
if not name.endswith(file_type):
continue
head, tail = os.path.split(name)
tail = os.path.splitext(tail)[0]
if "@" in tail:
all_names_set.add(tail.split('@')[0])
else:
all_names_set.add(tail)
return all_names_set
def do_grep(path, key_word):
if not is_available_file_path(path):
print ('path:%s is not available' % path)
return
command = "grep -w -q '%s' '%s'" %(key_word, path)
if subprocess.call(command, shell=True) == 0:
return 1
else:
return 0
def goal_file(path):
files = []
for dirName, subdirList, fileList in os.walk(path):
for fname in fileList:
if is_available_file_path(fname):
path = '%s/%s' % (dirName, fname)
files.append(path)
return files
def is_available_file_path(path):
available = 0
if path.endswith('.m'): available = 1
if path.endswith('.h'): available = 1
if path.endswith('.mm'): available = 1
if path.endswith('.xib'): available = 1
if path.endswith('.swift'): available = 1
if path.endswith('.storyboard'): available = 1
return available
def support_types():
types = []
types.append('png')
types.append('jpg')
types.append('jpeg')
types.append('gif')
return types
def delete_not_used_image(image):
if len(image) == 0:
return
command = "find '{}' \( -name '{other1}' -o -name '{other2}@*' \) 2>/dev/null".format(
project_dir, other1 = image, other2 = image)
s = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
results = s.communicate()[0].split()
for path in results:
valid = 0
for type in support_types():
if path.endswith(type):
valid = 1
break
if valid:
os.remove(path)
print ('\r\n ========%s is deleted========' % image)
def move_not_used_image(image):
if len(image) == 0:
return
command = "find '{}' \( -name '{other1}' -o -name '{other2}@*' \) 2>/dev/null".format(
project_dir, other1 = image, other2 = image)
s = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
results = s.communicate()[0].split()
for path in results:
valid = 0
for type in support_types():
if path.endswith(type):
valid = 1
break
if valid:
filename, file_extension = os.path.splitext(path)
des_dir = os.path.join(back_not_used_dir, "{}{}".format(image, file_extension))
shutil.move(path, des_dir)
print ('\r\n ========%s is moved========' % image)
def start_find_task():
print ("\nstart finding task...\nbelows are not used images:\n")
global project_dir
if len(sys.argv) > 1:
project_dir = sys.argv[1]
if project_dir == " ":
print ("error! project_dir can not be nil")
start = time.time()
i = 0
exclude_images_set = find_exclude_images()
results = set()
for type in support_types():
results = results | do_find_command(project_dir, type)
results = results - exclude_images_set
goal_files = goal_file(project_dir)
for image_name in results:
used = 0
for file_path in goal_files:
if do_grep(file_path, image_name):
used = 1
break
if used == 0:
print (image_name)
i = i + 1
if auto_delete:
delete_not_used_image(image_name)
elif auto_move:
move_not_used_image(image_name)
c = time.time() - start
print ('\nsearch finish, find %s results, total count %0.2f s' % (i, c))
start_find_task()
腳本也放到了 GitHub 上,可以自行下載。使用方式有兩種:
第一種,直接修改源碼裡的 project_dir 變量,然後執行:
python find_not_use_images.py
第二種,通過命令行參數傳入路徑:
python find_not_use_images.py /your path
另外兩個開關:auto_delete 表示是否直接刪除找到的無用圖片,默認 0 不刪;auto_move 表示是否把無用圖片移動到指定的 back_not_used_dir 目錄。上線前建議先用 move 模式跑一遍,確認結果無誤再考慮刪除。