Shopify_app 22.2.0版本更新后HomeController的最佳实践

背景介绍

Shopify_app作为Ruby on Rails开发Shopify应用的官方框架，在22.2.0版本中引入了一些重要的安全性和功能改进。这些变化对应用中默认生成的HomeController产生了影响，需要开发者重新评估其实现方式。

HomeController的传统实现

在旧版本的shopify_app中，通过生成器创建的HomeController通常包含以下关键组件：

class HomeController < ApplicationController
  include ShopifyApp::EmbeddedApp
  include ShopifyApp::EnsureInstalled
  include ShopifyApp::ShopAccessScopesVerification

  def index
    if ShopifyAPI::Context.embedded? && (!params[:embedded].present? || params[:embedded] != "1")
      redirect_to(ShopifyAPI::Auth.embedded_app_url(params[:host]) + request.path, allow_other_host: true)
    else
      @shop_origin = current_shopify_domain
      @host = params[:host]
    end
  end
end

这种实现主要处理两种情况：

1. 当应用未嵌入Shopify管理界面时，重定向到正确的嵌入URL
2. 当应用已正确嵌入时，设置必要的实例变量

22.2.0版本带来的变化

新版本中，Shopify对身份验证流程和安全机制进行了改进，特别是：

• 改进了会话令牌处理方式
• 优化了嵌入应用的加载流程
• 增强了安全性验证机制

这些变化使得传统的HomeController实现可能不再是最佳选择，特别是其中的重定向逻辑可能变得冗余。

现代实现建议

基于22.2.0版本的变化，推荐采用更简洁的HomeController实现：

class HomeController < ApplicationController
  include ShopifyApp::EmbeddedApp
  include ShopifyApp::EnsureInstalled
  include ShopifyApp::ShopAccessScopesVerification

  def index
    @load_path = authenticated_products_path
  end
end

这种实现方式：

1. 保留了必要的安全验证模块
2. 移除了复杂的重定向逻辑
3. 通过设置@load_path变量为前端提供初始加载路径

前端集成方案

在对应的视图模板中，可以通过以下方式与前端框架（如Turbo）集成：

<%= tag.div(
      id: 'app_data',
      data: {
        load_path: params[:return_to] || @load_path,
        # 其他必要的数据属性
      }
    ) 
%>

这种模式允许：

• 当用户直接访问应用根路径时，重定向到默认路径（如商品列表）
• 当从Shopify侧边栏点击特定链接时，使用return_to参数跳转到目标页面
• 保持Turbo驱动的单页应用体验

关键考虑因素

1. 安全验证：EnsureInstalled和ShopAccessScopesVerification模块仍然是必需的，它们确保应用已正确安装并具有所需权限

2. 嵌入式体验：EmbeddedApp模块处理了应用在Shopify管理界面中的嵌入逻辑

3. 前端路由：将路由控制逻辑更多地交给前端框架处理，简化后端控制器

4. 向后兼容：新实现仍然兼容旧版Shopify应用的行为模式

总结

随着Shopify_app框架的演进，开发者应该定期审查和更新应用的核心控制器实现。22.2.0版本后，HomeController可以简化为主要处理安全验证和提供基本路由信息，而将复杂的重定向和路由逻辑交给框架和前端处理。这种模式不仅更简洁，也更符合现代Shopify应用的开发实践。