org.swiftboot.data.model.interceptor.TimeInterceptor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swiftboot-data Show documentation
Data access component based on Spring-Data-JPA
There is a newer version: 2.4.8
package org.swiftboot.data.model.interceptor;

import org.apache.commons.lang3.StringUtils;
import org.hibernate.EmptyInterceptor;
import org.hibernate.type.CollectionType;
import org.hibernate.type.Type;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.swiftboot.data.config.SwiftBootDataConfigBean;
import org.swiftboot.data.model.entity.TimePersistable;
import org.swiftboot.data.util.HibernateUtils;

import javax.annotation.Resource;
import java.io.Serializable;
import java.util.Objects;

import static org.swiftboot.data.constant.AutoUpdateTimeStrategy.*;

/**
 * 自动设置实体的创建时间（createTime）和更新时间（updateTime）。
 * 对于子集合来说，新创建的实体类会调用 {@code onSave} 方法， merge 实体类会调用 {@code onFlushDirty} 方法。
 * 对于直接持久化的实体来说，如果数据没有改变但是配置为强制设置更新时间的情况下，需要通过 {@code UpdateTimeAspect} 来实现。
 *
 * @author swiftech
 * @see org.swiftboot.data.model.aspect.UpdateTimeAspect
 * @since 2.0.0
 */
public class TimeInterceptor extends EmptyInterceptor {

    public static final String CREATE_TIME = "createTime";
    public static final String UPDATE_TIME = "updateTime";

    private static final Logger log = LoggerFactory.getLogger(TimeInterceptor.class);

    @Resource
    private SwiftBootDataConfigBean configBean;

    @Override
    public boolean onSave(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types) {
        log.trace("onSave()");
        boolean changed = false;
        if (entity instanceof TimePersistable) {
            if (log.isDebugEnabled())
                log.debug("Auto set createTime for entity: " + StringUtils.substringAfterLast(entity.toString(), "."));
            for (int i = 0; i < propertyNames.length; i++) {
                String pname = propertyNames[i];
                if (CREATE_TIME.equals(pname)) {
                    state[i] = HibernateUtils.nowByType(types[i]);
                    changed = true;
                }
            }
        }
        return changed;
    }

    @Override
    public boolean onFlushDirty(Object entity, Serializable id, Object[] currentState, Object[] previousState, String[] propertyNames, Type[] types) {
        log.trace("onFlushDirty()");
        boolean changed = false;
        String updateTimeStrategy = configBean.getModel().getAutoUpdateTimeStrategy();
        if (AUTO_UPDATE_TIME_NOT_SET.equals(updateTimeStrategy)) {
            return changed;
        }

        if (entity instanceof TimePersistable) {
            if (log.isDebugEnabled())
                log.debug("Auto set createTime for entity: " + StringUtils.substringAfterLast(entity.toString(), "."));
            // find if data changed (except createTime and updateTime)
            boolean dataChanged = false;
            for (int i = 0; i < propertyNames.length; i++) {
                String propertyName = propertyNames[i];
                if (CREATE_TIME.equals(propertyName) || UPDATE_TIME.equals(propertyName))
                    continue; // createTime and updateTime are not handled by client.
                if (types[i] instanceof CollectionType)
                    continue; // sub-collection will be handled after parent entity's onSave(), which means sub-collection will make parent dirty.
                if (!Objects.equals(previousState[i], currentState[i])) {
                    dataChanged = true;
                    break;
                }
            }

            for (int i = 0; i < propertyNames.length; i++) {
                String propertyName = propertyNames[i];
                if (CREATE_TIME.equals(propertyName)) {
                    currentState[i] = previousState[i]; // restore createTime for merged entities
                }
                else if (UPDATE_TIME.equals(propertyName)) {
                    if (AUTO_UPDATE_TIME_ALWAYS.equals(updateTimeStrategy) ||
                            (AUTO_UPDATE_TIME_ON_CHANGE.equals(updateTimeStrategy)) && dataChanged) { // force or really changed entities will be updated updateTime.
                        currentState[i] = HibernateUtils.nowByType(types[i]);
                        changed = true; // mark as changed
                    }
                    else {
                        currentState[i] = previousState[i]; // restore updateTime for merged entities if no need to update.
                    }
                }
            }
        }
        return changed;
    }


}