Shopify应用卸载时如何删除主题内的对应文件及插入的代码

常见操作失效原因排查 #

• 权限与webhook配置问题：首先确认应用已申请write_themes权限，且注册的app/uninstalled webhook未被业务逻辑阻塞，Shopify卸载webhook最多重试48小时，一旦错过就没有二次回调入口
• 主题ID匹配错误：如果仅存储用户安装时的激活主题ID，用户后续切换主题后，你注入代码的主题和卸载时查询到的激活主题不匹配，就会出现删不到的情况
• 注入内容无专属标记：插入代码时没有加唯一标识的边界注释，卸载时无法精准定位你插入的代码，会出现匹配失败、删错内容的问题

正确实现步骤 #

注入阶段前置准备 #

不管是新增主题文件还是往现有文件插入代码，都要先做好标记和数据持久化：

• 新增的独立主题文件统一使用应用专属前缀命名，比如snippets/myapp_xxxx_banner.liquid，避免和主题原生文件、其他应用文件混淆
• 往现有主题文件插入代码时，前后必须加唯一标识的注释边界，示例：

<!-- BEGIN MY_APP_123456_INJECTION -->
你插入的业务代码
<!-- END MY_APP_123456_INJECTION -->

MY_APP_123456需替换为你应用的唯一标识，禁止使用通用字符串

• 所有注入过的资源（包括关联的店铺ID、主题ID、插入代码的文件路径、新增文件的完整路径）全部存在自己的服务端数据库，不要依赖Shopify接口反向查询

卸载回调清理逻辑 #

收到app/uninstalled回调时，先从数据库拉取当前店铺关联的所有注入资源记录，分两类处理：

• 删除新增的独立文件：调用Shopify Admin API的DELETE /admin/api/2024-07/themes/{theme_id}/assets.json?asset[key]={文件路径}接口直接删除即可，路径和创建时保持完全一致
• 清理现有文件中插入的代码：先调用GET /admin/api/2024-07/themes/{theme_id}/assets.json?asset[key]={目标文件路径}拉取文件当前完整内容，用正则匹配你预留的首尾注释边界，把标记和中间的代码一起删除后，再调用资产更新接口把处理后的内容写回文件。正则建议用多行匹配模式，比如JavaScript示例：/<!-- BEGIN MY_APP_123456_INJECTION -->[\s\S]*?<!-- END MY_APP_123456_INJECTION -->/g，可以完整匹配标记包裹的所有内容

容错处理 #

• 清理过程中遇到主题不存在、文件已被手动删除的报错直接跳过即可，不要中断整个清理流程
• 提前申请离线访问权限，避免收到卸载回调时店铺access_token已经失效，无法调用主题API

注意事项 #

• 主题修改会在用户后台生成版本记录，清理操作不要添加任何无关修改，避免引起用户疑惑
• 不要修改任何你没有注入过的代码内容，避免引发主题故障

内容的提问来源于stack exchange，提问作者user17247900