Hybris注册页添加自定义属性教程

积累知识，胜过积蓄金银！毕竟在文章开发的过程中，会遇到各种各样的问题，往往都是一些细节知识点还没有掌握好而导致的，因此基础知识点的积累是很重要的。下面本文《Hybris注册页添加自定义属性全攻略》，就带大家讲解一下知识点，若是你对本文感兴趣，或者是想搞懂其中某个知识点，就请你继续往下看吧~

本文详细介绍了如何在Hybris注册页面添加自定义属性，并确保其数据能够从前端表单正确传递、验证并持久化到数据库。通过扩展RegisterForm、RegisterData、RegistrationPageController和CustomerFacade等核心组件，读者将掌握实现端到端数据流的专业方法，解决自定义属性值无法保存或触发强制属性验证错误的问题。

在Hybris电商平台中，为满足业务需求，我们经常需要在用户注册流程中添加自定义信息字段，例如用户身份证号、兴趣爱好等。然而，简单地在前端页面添加输入框并修改模型定义，往往不足以确保数据的正确捕获、传输和持久化。本文将以在注册页面添加一个名为“Pan”（泛印卡号）的自定义属性为例，详细阐述从前端到后端数据持久化的完整实现步骤。

问题剖析

当尝试在Hybris注册页面添加新属性时，常见的错误是遇到de.hybris.platform.servicelayer.exceptions.ModelSavingException: missing values for [pan] in model CustomerModel。这通常发生在将新属性定义为强制（mandatory）时，但系统在创建CustomerModel时未能从前端获取并设置该值。即使通过设置optional="true"暂时解决了这个错误，新属性的值仍然无法保存到数据库中。

其根本原因在于，Hybris的注册流程涉及多个层级的数据传递：前端表单数据首先绑定到表单对象（如RegisterForm），然后传递给数据传输对象（如RegisterData），再由控制器（如RegistrationPageController）调用门面层（如CustomerFacade），最终由门面层将数据映射到持久化模型（如CustomerModel）并保存。如果自定义属性没有在这些关键层级中得到正确的扩展和传递，那么即使前端输入了值，后端也无法接收并保存它。

Hybris注册流程中的数据流核心概念

理解Hybris注册流程中的数据流至关重要。简而言之，它遵循以下路径：

1. 前端JSP页面： 用户输入数据。
2. RegisterForm： 用于接收前端表单提交的数据。
3. RegisterData： 用于在业务逻辑层（控制器与门面之间）传递注册相关的数据。
4. RegistrationPageController： 处理前端请求，将RegisterForm数据转换为RegisterData，并调用CustomerFacade。
5. CustomerFacade： 业务逻辑层，负责将RegisterData中的数据映射到CustomerModel，并触发模型保存。
6. CustomerModel： 持久化模型，最终存储在数据库中。

要成功添加自定义属性，我们需要确保这个数据流中的每一个环节都能够识别、携带并处理这个新属性。

实现步骤

以下是为Hybris注册页面添加自定义属性“Pan”的详细步骤：

1. 定义新的模型属性 (items.xml)

首先，在您的Hybris扩展的items.xml文件中，为Customer类型添加新的属性定义。

<!-- Your custom extension's items.xml -->
<itemtypes>
    <itemtype code="Customer" autocreate="false" generate="false">
        <attributes>
            <attribute qualifier="pan" type="java.lang.String">
                <description>PAN Card Number</description>
                <persistence type="property"/>
                <!-- 如果此属性必须填写，则将optional设置为false，否则为true。
                     在开发初期可设为true，待数据流打通后再改为false。 -->
                <modifiers optional="true"/>
            </attribute>
        </attributes>
    </itemtype>
</itemtypes>

注意事项：

• autocreate="false"和generate="false"表示我们是在扩展现有类型，而不是创建新类型。
• optional="true"表示该字段在数据库层面可以为空。如果业务要求该字段必填，应在所有数据流环节打通后，再将此处改为optional="false"，并确保前端和后端都有相应的验证逻辑。
• 完成items.xml修改后，需要运行ant all并重启Hybris服务器，以更新数据库 schema。

2. 扩展注册表单数据对象 (RegisterForm)

创建或修改一个类来扩展Hybris OOTB的RegisterForm，添加pan字段。

// 例如: YourExtensionRegisterForm.java
package com.yourcompany.facades.forms; // 示例包名

import de.hybris.platform.acceleratorstorefrontcommons.forms.RegisterForm;

public class YourExtensionRegisterForm extends RegisterForm {

    private String pan;

    public String getPan() {
        return pan;
    }

    public void setPan(String pan) {
        this.pan = pan;
    }
}

3. 扩展注册数据传输对象 (RegisterData)

类似地，扩展RegisterData，使其包含pan字段。

// 例如: YourExtensionRegisterData.java
package com.yourcompany.facades.data; // 示例包名

import de.hybris.platform.commercefacades.user.data.RegisterData;

public class YourExtensionRegisterData extends RegisterData {

    private String pan;

    public String getPan() {
        return pan;
    }

    public void setPan(String pan) {
        this.pan = pan;
    }
}

4. 修改注册页面控制器 (RegistrationPageController)

您需要创建一个新的控制器来扩展或替换Hybris OOTB的RegistrationPageController，以处理新的表单字段。

// 例如: YourExtensionRegistrationPageController.java
package com.yourcompany.storefront.controllers.pages; // 示例包名

import com.yourcompany.facades.forms.YourExtensionRegisterForm; // 导入您的扩展表单
import com.yourcompany.facades.data.YourExtensionRegisterData; // 导入您的扩展数据对象
import de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.Abstract='de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.RegisterPageController';
import de.hybris.platform.acceleratorstorefrontcommons.forms.GuestForm;
import de.hybris.platform.acceleratorstorefrontcommons.forms.LoginForm;
import de.hybris.platform.cms2.exceptions.CMSItemNotFoundException;
import de.hybris.platform.commercefacades.user.UserFacade; // 假设您注入了UserFacade或您的扩展Facade
import de.hybris.platform.commercefacades.user.data.RegisterData;
import de.hybris.platform.servicelayer.exceptions.ModelSavingException; // 用于捕获保存异常

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.mvc.support.RedirectAttributes;

import javax.annotation.Resource;
import javax.validation.Valid;

@Controller
@RequestMapping(value = "/register")
public class YourExtensionRegistrationPageController extends AbstractRegisterPageController {

    @Resource(name = "userFacade") // 注入您的UserFacade或扩展的CustomerFacade
    private UserFacade userFacade;

    // 您可能需要覆盖或新增一个处理注册请求的方法
    @RequestMapping(value = "/newcustomer", method = RequestMethod.POST)
    public String doRegister(
            @Valid final YourExtensionRegisterForm form, // 使用您的扩展表单
            final BindingResult bindingResult, final Model model,
            final RedirectAttributes redirectModel) throws CMSItemNotFoundException {

        // 默认的注册逻辑，确保CMS内容加载
        processPage(model);
        model.addAttribute("guestForm", new GuestForm());
        model.addAttribute("loginForm", new LoginForm());

        if (bindingResult.hasErrors()) {
            model.addAttribute(form);
            model.addAttribute("registerSuccess", Boolean.FALSE);
            return getView();
        }

        // 创建您的扩展RegisterData实例
        final YourExtensionRegisterData registerData = new YourExtensionRegisterData();
        // 将表单数据拷贝到RegisterData
        registerData.setFirstName(form.getFirstName());
        registerData.setLastName(form.getLastName());
        registerData.setEmail(form.getEmail());
        registerData.setPassword(form.getPassword());
        registerData.setTitleCode(form.getTitleCode());
        registerData.setConsentGiven(form.getConsentGiven());
        // 关键步骤：将新的PAN字段从表单拷贝到RegisterData
        registerData.setPan(form.getPan()); // <-- 重点

        try {
            getUserFacade().register(registerData); // 调用UserFacade的注册方法
            getAutoLoginStrategy().login(form.getEmail(), form.getPassword(), request, response);
            // 注册成功后的重定向
            return REDIRECT_PREFIX + getSuccessRedirect(request, response);

        } catch (final ModelSavingException e) {
            // 处理模型保存异常，例如强制属性缺失
            model.addAttribute(form);
            model.addAttribute("registerSuccess", Boolean.FALSE);
            GlobalMessages.addErrorMessage(model, "registration.error.account.exists"); // 或更具体的错误信息
            return getView();
        } catch (final Exception e) {
            // 其他异常处理
            model.addAttribute(form);
            model.addAttribute("registerSuccess", Boolean.FALSE);
            GlobalMessages.addErrorMessage(model, "registration.error.general");
            return getView();
        }
    }

    // 确保您的Controller在Spring配置中被扫描到，或者手动配置bean
}

注意事项：

• 您可能需要修改web/src/com/yourcompany/storefront/controllers/ControllerConstants.java来引用新的控制器类。
• 确保您的Spring配置（如web-spring.xml）正确地配置了您的控制器，使其能够处理/register/newcustomer请求。
• 使用@Valid注解触发表单验证。

5. 扩展客户门面 (CustomerFacade)

您需要创建一个新的门面类来扩展或替换Hybris OOTB的DefaultCustomerFacade，并修改其register方法以处理新的pan字段。

// 例如: DefaultYourExtensionCustomerFacade.java
package com.yourcompany.facades.impl; // 示例包名

import com.yourcompany.facades.data.YourExtensionRegisterData; // 导入您的扩展数据对象
import de.hybris.platform.commercefacades.user.impl.DefaultCustomerFacade;
import de.hybris.platform.commercefacades.user.data.RegisterData;
import de.hybris.platform.core.model.user.CustomerModel; // 导入CustomerModel
import de.hybris.platform.servicelayer.model.ModelService; // 注入ModelService
import de.hybris.platform.servicelayer.exceptions.ModelSavingException;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.util.Assert;

public class DefaultYourExtensionCustomerFacade extends DefaultCustomerFacade {

    @Autowired
    private ModelService modelService; // 注入ModelService用于保存模型

    @Override
    public void register(final RegisterData registerData) {
        Assert.notNull(registerData, "RegisterData cannot be null");

        // 首先调用父类的注册逻辑，它会创建并填充CustomerModel的大部分字段
        // 注意：如果父类方法直接保存了模型，您可能需要修改父类方法或在保存前拦截
        // 更推荐的做法是，如果父类register方法内部没有保存模型，而是返回了模型对象，
        // 那么可以在这里获取模型并添加pan字段。
        // 如果父类直接保存了，您可能需要复制父类的逻辑并添加您的字段。
        // 这里假设父类方法会设置大部分字段，我们在此基础上添加pan。

        // 假设registerData是YourExtensionRegisterData的实例
        if (registerData instanceof YourExtensionRegisterData) {
            final YourExtensionRegisterData yourExtensionRegisterData = (YourExtensionRegisterData) registerData;

            // 获取或创建CustomerModel
            final CustomerModel newCustomer = getModelService().create(CustomerModel.class);
            // 填充CustomerModel的基础字段（通常由父类或转换器完成）
            // 这里我们假设父类或某个转换器已经将大部分RegisterData字段映射到newCustomer
            // 如果不是，您需要手动映射：
            newCustomer.setUid(yourExtensionRegisterData.getEmail());
            newCustomer.setName(yourExtensionRegisterData.getFirstName() + " " + yourExtensionRegisterData.getLastName());
            newCustomer.setSessionCurrency(getCommonI18NService().getCurrentCurrency());
            newCustomer.setSessionLanguage(getCommonI18NService().getCurrentLanguage());
            newCustomer.setTitle(getUserService().getTitleForCode(yourExtensionRegisterData.getTitleCode()));
            newCustomer.setCustomer(true);

            // 关键步骤：将PAN字段从RegisterData映射到CustomerModel
            newCustomer.setPan(yourExtensionRegisterData.getPan()); // <-- 重点

            try {
                getModelService().save(newCustomer); // 保存CustomerModel
                // 密码加密等后续操作通常在UserService中完成
                getUserService().setPassword(newCustomer, yourExtensionRegisterData.getPassword(),
                        yourExtensionRegisterData.getPasswordConfirmation());
            } catch (final ModelSavingException e) {
                // 处理保存异常
                throw e; // 重新抛出以便控制器捕获
            }
        } else {
            // 如果传入的不是您的扩展RegisterData，则执行父类逻辑
            super.register(registerData);
        }
    }

    // 确保您的Facade在Spring配置中被正确注入，例如在core-spring.xml或facades-spring.xml中
    // <bean id="customerFacade" class="com.yourcompany.facades.impl.DefaultYourExtensionCustomerFacade" parent="defaultCustomerFacade"/>
}

注意事项：

• 在Spring配置中，您需要将customerFacade bean指向您的新类，例如通过parent属性继承OOTB的配置。
• getModelService().save(newCustomer)是真正将数据持久化到数据库的关键一步。
• 如果CustomerModel的pan属性被定义为强制的（optional="false"），那么在getModelService().save(newCustomer)之前，newCustomer.getPan()必须是非空的，否则会抛出ModelSavingException。

6. 更新前端JSP页面

最后，在您的注册JSP页面（通常位于_ui/addons/acceleratorstorefrontcommons/web/webroot/WEB-INF/views/responsive/pages/account/accountRegisterPage.jsp或您的自定义路径）中，添加新的输入字段。

<%-- 例如: accountRegisterPage.jsp --%>
<%@ taglib prefix="form" uri="http://www.springframework.org/tags/form" %>
<%@ taglib prefix="spring" uri="http://www.springframework.org/tags" %>

<form:form id="registerForm" commandName="registerForm" action="${registerActionUrl}" method="post">
    <%-- 其他现有字段，如 firstName, lastName, email, password 等 --%>

    <div class="form-group">
        <label class="control-label" for="pan">
            <spring:theme code="register.pan" text="PAN Number" />
            <span class="mandatory">
                <spring:theme code="form.required" text="*" />
            </span>
        </label>
        <form:input cssClass="form-control" id="pan" path="pan" type="text" placeholder="${spring:themeCode('register.pan.placeholder')}" />
        <form:errors path="pan" cssClass="help-block" />
    </div>

    <%-- 其他表单元素和提交按钮 --%>
    <button type="submit" class="btn btn-primary">
        <spring:theme code="register.registerButton" text="Register" />
    </button>
</form:form>

注意事项：

• 确保path="pan"与您的YourExtensionRegisterForm中的pan属性名一致。
• spring:theme标签用于国际化，您需要在相应的messages_zh.properties等文件中添加register.pan和register.pan.placeholder的键值对。

高级考量与最佳实践

• 数据验证： 除了后端items.xml的optional属性外，您还应该在YourExtensionRegisterForm中使用JSR 303/349注解（如@NotNull, @Size, @Pattern）进行表单级别的验证，并在前端JSP中使用JavaScript进行客户端验证，提供即时反馈。
• 使用Converter： 对于更复杂的对象或多个字段的映射，推荐使用Hybris的Converter和Populator机制，而不是在Facade中手动进行字段拷贝。这能提高代码的可维护性和复用性。
• 错误处理： 在控制器和门面层，确保捕获并处理可能发生的异常（如ModelSavingException），并向用户提供友好的错误信息。
• Hybris更新系统： 每次修改items.xml后，务必运行ant all并重启服务器，确保数据库结构与模型定义同步。

总结

在Hybris注册页面添加自定义属性，不仅仅是修改前端JSP和后端模型定义那么简单。它要求开发者深入理解Hybris的数据流机制，并对RegisterForm、RegisterData、RegistrationPageController和CustomerFacade等核心组件进行相应的扩展和调整。通过确保数据在每个层级都得到正确地传递和处理，我们才能成功地将自定义属性从用户输入端持久化到数据库中，从而满足复杂的业务需求，并避免常见的强制属性缺失或数据无法保存的错误。

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于文章的相关知识，也可关注golang学习网公众号。