net.ymate.platform.validation.Validations Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2007-2017 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.validation;

import net.ymate.platform.core.Version;
import net.ymate.platform.core.YMP;
import net.ymate.platform.core.beans.BeanMeta;
import net.ymate.platform.core.beans.intercept.InterceptAnnoHelper;
import net.ymate.platform.core.module.IModule;
import net.ymate.platform.core.module.annotation.Module;
import net.ymate.platform.core.util.RuntimeUtils;
import net.ymate.platform.validation.annotation.Validation;
import net.ymate.platform.validation.annotation.Validator;
import net.ymate.platform.validation.handle.ValidateHandler;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * 验证框架模块管理器
 *
 * @author 刘镇 ([email protected]) on 2013-4-7 下午4:43:48
 * @version 1.0
 */
@Module
public class Validations implements IModule, IValidation {

    public static final Version VERSION = new Version(2, 0, 8, Validations.class.getPackage().getImplementationVersion(), Version.VersionType.Release);

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

    private static volatile IValidation __instance;

    private YMP __owner;

    private boolean __inited;

    private Map, Class> __validators;

    private Map, ValidationMeta> __VALIDATION_META_CACHES;

    /**
     * @return 返回默认验证框架管理器实例对象
     */
    public static IValidation get() {
        if (__instance == null) {
            synchronized (VERSION) {
                if (__instance == null) {
                    __instance = YMP.get().getModule(Validations.class);
                }
            }
        }
        return __instance;
    }

    /**
     * @param owner YMP框架管理器实例
     * @return 返回指定YMP框架管理器容器内的验证框架管理器实例
     */
    public static IValidation get(YMP owner) {
        return owner.getModule(Validations.class);
    }

    @Override
    public String getName() {
        return IValidation.MODULE_NAME;
    }

    @Override
    public void init(YMP owner) throws Exception {
        if (!__inited) {
            //
            _LOG.info("Initializing ymate-platform-validation-" + VERSION);
            //
            __owner = owner;
            __validators = new HashMap, Class>();
            __VALIDATION_META_CACHES = new HashMap, ValidationMeta>();
            __owner.registerHandler(Validator.class, new ValidateHandler(this));
            //
            __inited = true;
        }
    }

    @Override
    public boolean isInited() {
        return __inited;
    }

    @Override
    public YMP getOwner() {
        return __owner;
    }

    @Override
    public void registerValidator(Class annotationClass, Class validatorClass) {
        try {
            __owner.registerBean(BeanMeta.create(validatorClass, true));
            __validators.put(annotationClass, validatorClass);
        } catch (Exception e) {
            _LOG.error("", RuntimeUtils.unwrapThrow(e));
        }
    }

    @Override
    public boolean containsValidator(Class annotationClass) {
        return __validators.containsKey(annotationClass);
    }

    @Override
    public Map validate(Class targetClass, Map paramValues) {
        Map _returnValues = new LinkedHashMap();
        ValidationMeta _meta = __doGetCachedMeta(targetClass);
        Map _contextParams = InterceptAnnoHelper.getContextParams(__owner, targetClass, null);
        for (String _fieldName : _meta.getFieldNames()) {
            ValidateResult _result = __doValidate(_meta.getFieldAnnotations(_fieldName), _fieldName, _meta.getFieldLabel(_fieldName), paramValues, _contextParams, _meta.getResourcesName());
            if (_result != null) {
                _returnValues.put(_fieldName, _result);
                if (_meta.getMode() == Validation.MODE.NORMAL) {
                    break;
                }
            }
        }
        return _returnValues;
    }

    @Override
    public Map validate(Class targetClass, Method targetMethod, Map paramValues) {
        Map _returnValues = new LinkedHashMap();
        ValidationMeta _meta = __doGetCachedMeta(targetClass);
        Validation _validation = _meta.getMethodValidation(targetMethod);
        Validation.MODE _mode = _validation == null ? _meta.getMode() : _validation.mode();
        String _resourceName = _validation == null ? _meta.getResourcesName() : (StringUtils.defaultIfBlank(_validation.resourcesName(), _meta.getResourcesName()));
        //
        Map _paramAnnoMap = _meta.getMethodParamAnnotations(targetMethod);
        Map _contextParams = InterceptAnnoHelper.getContextParams(__owner, targetClass, targetMethod);
        for (Map.Entry _entry : _paramAnnoMap.entrySet()) {
            ValidateResult _result = __doValidate(_entry.getValue(), _entry.getKey(), _meta.getFieldLabel(targetMethod, _entry.getKey()), paramValues, _contextParams, _resourceName);
            if (_result != null) {
                _returnValues.put(_entry.getKey(), _result);
                //
                if (_mode == Validation.MODE.NORMAL) {
                    break;
                }
            }
        }
        return _returnValues;
    }

    /**
     * @param targetClass 目标类型
     * @return 缓存中获取目标类型验证配置描述，若不存在则尝试创建它并加入缓存中
     */
    private ValidationMeta __doGetCachedMeta(Class targetClass) {
        ValidationMeta _meta = __VALIDATION_META_CACHES.get(targetClass);
        if (_meta == null) {
            _meta = new ValidationMeta(this, targetClass);
            __VALIDATION_META_CACHES.put(targetClass, _meta);
        }
        return _meta;
    }

    private ValidateResult __doValidate(Annotation[] annotations, String paramName, String paramLabel, Map paramValues, Map contextParams, String resourceName) {
        ValidateResult _result = null;
        for (Annotation _ann : annotations) {
            IValidator _validator = __owner.getBean(__validators.get(_ann.annotationType()));
            _result = _validator.validate(new ValidateContext(__owner, _ann, paramName, paramLabel, paramValues, contextParams, resourceName));
            if (_result != null) {
                break;
            }
        }
        return _result;
    }

    @Override
    public void destroy() throws Exception {
        if (__inited) {
            __inited = false;
            //
            __VALIDATION_META_CACHES = null;
            __validators = null;
            __owner = null;
        }
    }
}