如何在Liferay CMS中实现内容变更的回调通知（Java编程实现）

要实现Liferay文档库中指定文件夹层级（含子文件夹）内文件增删改的通知，核心是利用Liferay的Model Listener机制，监听文档库文件（DLFileEntry）的生命周期事件，再判断文件所在文件夹是否属于目标层级，最后执行通知逻辑。

实现步骤 #

1. 自定义Model Listener类 #

创建一个继承BaseModelListener<DLFileEntry>的类，监听文件的创建、更新、删除事件：

import com.liferay.document.library.kernel.model.DLFileEntry;
import com.liferay.document.library.kernel.model.DLFolder;
import com.liferay.document.library.kernel.service.DLFolderLocalService;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.model.BaseModelListener;
import com.liferay.portal.kernel.model.ModelListener;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;

@Component(immediate = true, service = ModelListener.class)
public class DLFileEntryNotificationListener extends BaseModelListener<DLFileEntry> {

    // 替换为你的目标文件夹ID，建议通过系统配置/页面扩展字段动态获取
    private static final long TARGET_FOLDER_ID = 12345;

    @Reference
    private DLFolderLocalService _dlFolderLocalService;

    @Override
    public void onAfterCreate(DLFileEntry dlFileEntry) throws PortalException {
        triggerNotification(dlFileEntry, "新增");
    }

    @Override
    public void onAfterUpdate(DLFileEntry original, DLFileEntry updated) throws PortalException {
        triggerNotification(updated, "更新");
    }

    @Override
    public void onAfterRemove(DLFileEntry dlFileEntry) throws PortalException {
        triggerNotification(dlFileEntry, "删除");
    }

    private void triggerNotification(DLFileEntry fileEntry, String action) throws PortalException {
        long fileFolderId = fileEntry.getFolderId();

        // 判断文件所在文件夹是否在目标层级内（含子文件夹）
        if (isInTargetHierarchy(fileFolderId)) {
            // 这里替换为你的通知逻辑：邮件、内部消息、API调用等
            String notifyMsg = String.format(
                "文件【%s】已被%s，文件ID：%d，所在文件夹ID：%d",
                fileEntry.getFileName(), action, fileEntry.getFileEntryId(), fileFolderId
            );
            
            // 示例：打印日志，实际可替换为Liferay MailService发送邮件
            System.out.println(notifyMsg);
        }
    }

    // 递归判断文件夹是否属于目标层级的后代（含自身）
    private boolean isInTargetHierarchy(long folderId) throws PortalException {
        if (folderId == TARGET_FOLDER_ID) {
            return true;
        }

        DLFolder currentFolder = _dlFolderLocalService.fetchDLFolder(folderId);
        if (currentFolder == null) {
            return false;
        }

        long parentFolderId = currentFolder.getParentFolderId();
        // 根文件夹ID为0，说明已到顶层，未找到目标文件夹
        if (parentFolderId == 0) {
            return false;
        }

        return isInTargetHierarchy(parentFolderId);
    }
}

2. 关键细节说明 #

• 目标文件夹ID动态化：不要硬编码TARGET_FOLDER_ID，可以通过以下方式获取：
  • 利用页面的扩展字段（Expando）存储关联的文件夹ID，在监听方法中通过页面的GroupId和页面ID查询扩展字段值。
  • 通过Liferay系统设置（System Settings）添加配置项，动态读取目标文件夹ID。
• 通知逻辑扩展：
  • 发送邮件：注入MailService，构建MailMessage发送通知。
  • 内部消息：调用UserNotificationLocalService给指定用户发送站内消息。
  • 外部通知：调用第三方API或消息队列（如RabbitMQ）推送事件。
• 处理文件夹移动场景：如果需要监听文件夹移动到目标层级的情况，可以额外创建DLFolderModelListener，监听文件夹更新事件，判断文件夹是否被移入目标层级，再批量触发该文件夹下所有文件的通知。

3. 部署与测试 #

• 将代码打包为OSGi模块（需配置bnd.bnd文件，声明依赖的Liferay API包）。
• 部署到Liferay的OSGi容器（如osgi/modules目录）。
• 在目标文件夹层级内增删改文件，检查通知是否触发。

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