net.ymate.platform.webmvc.support.WebCacheProcessor.java Source code

Introduction

Here is the source code for net.ymate.platform.webmvc.support.WebCacheProcessor.java

Source

/*
 * Copyright 2007-2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.ymate.platform.webmvc.support;

import net.ymate.platform.cache.Caches;
import net.ymate.platform.cache.ICaches;
import net.ymate.platform.core.i18n.I18N;
import net.ymate.platform.webmvc.IRequestContext;
import net.ymate.platform.webmvc.IWebCacheProcessor;
import net.ymate.platform.webmvc.IWebMvc;
import net.ymate.platform.webmvc.PageMeta;
import net.ymate.platform.webmvc.annotation.ResponseCache;
import net.ymate.platform.webmvc.context.WebContext;
import net.ymate.platform.webmvc.util.WebCacheHelper;
import net.ymate.platform.webmvc.view.IView;
import org.apache.commons.codec.digest.DigestUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.ByteArrayOutputStream;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.locks.ReentrantLock;

/**
 * @author  (suninformation@163.com) on 16/2/1 ?3:11
 * @version 1.0
 */
public class WebCacheProcessor implements IWebCacheProcessor {

    private final Log _LOG = LogFactory.getLog(WebCacheProcessor.class);

    private static ConcurrentHashMap<String, ReentrantLock> __LOCK_MAP = new ConcurrentHashMap<String, ReentrantLock>();

    public boolean processResponseCache(IWebMvc owner, ResponseCache responseCache, IRequestContext requestContext,
            IView resultView) throws Exception {
        HttpServletRequest _request = WebContext.getRequest();
        GenericResponseWrapper _response = (GenericResponseWrapper) WebContext.getResponse();

        String _cacheKey = __doBuildCacheKey(_request, responseCache);
        ICaches _caches = Caches.get(owner.getOwner());
        PageMeta _element = (PageMeta) _caches.get(responseCache.cacheName(), _cacheKey);
        if (_element == null && resultView != null) {
            // ??200?
            if (_response.getStatus() == HttpServletResponse.SC_OK) {
                _element = __doPutCacheElement(_response, _caches, responseCache, _cacheKey, resultView);
            }
        }
        if (_element != null) {
            // 
            WebCacheHelper.bind(_request, _response, _element, responseCache.scope()).writeResponse();
            //
            return true;
        }
        return false;
    }

    private PageMeta __doPutCacheElement(GenericResponseWrapper response, ICaches caches,
            ResponseCache responseCache, String cacheKey, IView resultView) throws Exception {
        ReentrantLock _locker = __doGetCacheLocker(cacheKey);
        _locker.lock();
        //
        PageMeta _element = null;
        try {
            // ??
            _element = (PageMeta) caches.get(responseCache.cacheName(), cacheKey);
            // ?
            if (_element == null || _element.isExpired()) {
                // ??
                ByteArrayOutputStream _output = new ByteArrayOutputStream();
                resultView.render(_output);

                _element = new PageMeta(response.getContentType(), response.getHeaders(), _output.toByteArray(),
                        responseCache.useGZip());
                // 
                int _timeout = responseCache.timeout() > 0 ? responseCache.timeout()
                        : caches.getModuleCfg().getDefaultCacheTimeout();
                if (_timeout > 0) {
                    _element.setTimeout(_timeout);
                }
                // 
                caches.put(responseCache.cacheName(), cacheKey, _element);
            }
        } catch (UnsupportedOperationException e) {
            _LOG.warn(
                    resultView.getClass().getName() + " Unsupported Render To OutputStream Operation, Skip Cache.");
        } finally {
            _locker.unlock();
        }
        return _element;
    }

    private ReentrantLock __doGetCacheLocker(String cacheKey) {
        ReentrantLock _locker = __LOCK_MAP.get(cacheKey);
        if (_locker == null) {
            _locker = new ReentrantLock();
            ReentrantLock _previous = __LOCK_MAP.putIfAbsent(cacheKey, _locker);
            if (_previous != null) {
                _locker = _previous;
            }
        }
        return _locker;
    }

    private String __doBuildCacheKey(HttpServletRequest request, ResponseCache responseCache) {
        // KEY
        StringBuilder _keyBuilder = new StringBuilder().append(ResponseCache.class.getName())
                .append(I18N.current());
        if (StringUtils.isNotBlank(responseCache.key())) {
            _keyBuilder.append(":").append(responseCache.key());
        } else {
            _keyBuilder.append(":").append(request.getMethod()).append(":").append(request.getRequestURI())
                    .append(":").append(request.getQueryString());
        }
        if (responseCache.scope().equals(ICaches.Scope.SESSION)) {
            _keyBuilder.insert(0, "|").insert(0, request.getSession().getId());
        }
        return DigestUtils.md5Hex(_keyBuilder.toString());
    }
}