com.github.developframework.kite.spring.ControllerKtlTemplateScanner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kite-spring Show documentation
Kite的Spring支持包
The newest version!
package com.github.developframework.kite.spring;

import com.github.developframework.kite.core.KiteFactory;
import com.github.developframework.kite.core.element.Template;
import com.github.developframework.kite.core.exception.KiteException;
import com.github.developframework.kite.core.source.StringConfigurationSource;
import com.github.developframework.kite.core.structs.FragmentLocation;
import com.github.developframework.kite.core.structs.TemplatePackage;
import com.github.developframework.kite.core.structs.TemplatePackageRegistry;
import com.github.developframework.kite.spring.mvc.annotation.KiteNamespace;
import com.github.developframework.kite.spring.mvc.annotation.TemplateKTL;
import lombok.RequiredArgsConstructor;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

import java.io.IOException;
import java.lang.reflect.Method;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Controller上@Template注解的扫描器
 *
 * @author qiushui on 2021-07-08.
 */
@RequiredArgsConstructor
public final class ControllerKtlTemplateScanner {

    private final KiteFactory kiteFactory;

    private final RequestMappingHandlerMapping handlerMapping;

    public Map scan() {
        final Map fragmentLocationMap = new HashMap<>();
        handlerMapping.getHandlerMethods().forEach((info, handlerMethod) -> {
            final TemplateKTL templateKTL = handlerMethod.getMethodAnnotation(TemplateKTL.class);
            if (templateKTL == null) {
                return;
            }
            final String ktl = String.join("\n", templateKTL.value());
            if (ktl.isBlank()) {
                return;
            }
            final List ktlTemplatePackages;
            try {
                ktlTemplatePackages = kiteFactory.getKtlParser().read(new StringConfigurationSource(ktl, StandardCharsets.UTF_8));
            } catch (IOException e) {
                throw new KiteException("KTL parse failed");
            }
            final String namespace = getNamespace(handlerMethod);
            final TemplatePackageRegistry registry = kiteFactory.getConfiguration().getTemplatePackageRegistry();
            final TemplatePackage ktlTemplatePackage = ktlTemplatePackages.get(0);
            // 把默认模板包设置成当前namespace并注册入模板包注册器
            if (ktlTemplatePackage.getNamespace().equals(TemplatePackage.DEFAULT_NAMESPACE)) {
                ktlTemplatePackage.setNamespace(namespace);
                registry.mergeTemplatePackage(ktlTemplatePackage);
            }
            final Template uniqueTemplate = ktlTemplatePackage.getUniqueTemplate();
            fragmentLocationMap.put(handlerMethod.getMethod(), uniqueTemplate.getFragmentLocation());
        });
        return fragmentLocationMap;
    }

    /**
     * 获取方法或类上标注的namespace
     *
     * @param handlerMethod 方法
     * @return namespace
     */
    private String getNamespace(HandlerMethod handlerMethod) {
        KiteNamespace kiteNamespace = handlerMethod.getMethodAnnotation(KiteNamespace.class);
        if (kiteNamespace == null) {
            final Class controllerClass = handlerMethod.getBeanType();
            kiteNamespace = controllerClass.getAnnotation(KiteNamespace.class);
            if (kiteNamespace == null) {
                throw new KiteException("@KiteNamespace is not marked on the \"%s\" method, or @KiteNamespace is globally marked on the Controller class", controllerClass.getName() + "." + handlerMethod.getMethod().getName());
            }
        }
        return kiteNamespace.value();
    }
}