org.lastaflute.web.aspect.RomanticActionCustomizer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lastaflute Show documentation
Show all versions of lastaflute Show documentation
Typesafe Web Framework for LeAn STArtup with DBFlute and Java8
/*
* Copyright 2015-2018 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 org.lastaflute.web.aspect;
import java.lang.reflect.Method;
import java.util.Map;
import java.util.Map.Entry;
import org.dbflute.helper.message.ExceptionMessageBuilder;
import org.dbflute.util.Srl;
import org.lastaflute.core.direction.FwAssistantDirector;
import org.lastaflute.core.util.ContainerUtil;
import org.lastaflute.di.core.ComponentDef;
import org.lastaflute.di.core.customizer.ComponentCustomizer;
import org.lastaflute.di.util.LdiModifierUtil;
import org.lastaflute.web.Execute;
import org.lastaflute.web.direction.FwWebDirection;
import org.lastaflute.web.exception.ActionPackageHasUpperCaseException;
import org.lastaflute.web.exception.ExecuteMethodIllegalDefinitionException;
import org.lastaflute.web.path.ActionAdjustmentProvider;
import org.lastaflute.web.ruts.config.ActionExecute;
import org.lastaflute.web.ruts.config.ActionMapping;
import org.lastaflute.web.ruts.config.ExecuteOption;
import org.lastaflute.web.ruts.config.ModuleConfig;
import org.lastaflute.web.util.LaModuleConfigUtil;
/**
* You can get romantic action.
* @author jflute
*/
public class RomanticActionCustomizer implements ComponentCustomizer {
// ===================================================================================
// Customize
// =========
@Override
public void customize(ComponentDef componentDef) {
final ActionMapping actionMapping = createActionMapping(componentDef);
getModuleConfig().addActionMapping(actionMapping);
}
// ===================================================================================
// Action Mapping
// ==============
protected ActionMapping createActionMapping(ComponentDef actionDef) {
final String actionName = buildActionName(actionDef);
verifyPackageConvention(actionDef, actionName);
final ActionMapping mapping = newActionMapping(actionDef, actionName, comeOnAdjustmentProvider());
setupMethod(mapping);
return mapping;
}
protected String buildActionName(ComponentDef actionDef) {
return actionDef.getComponentName();
}
protected void verifyPackageConvention(ComponentDef actionDef, String actionName) {
if (actionName.contains("_")) {
final String packageExp = Srl.substringLastFront(actionName, "_");
if (containsNotAllowedCharacterAsActionPath(packageExp)) { // e.g. seaLand_seaLandAction
throwActionPackageHasUpperCaseException(actionDef, actionName);
}
}
}
protected boolean containsNotAllowedCharacterAsActionPath(String packageExp) {
return Srl.isUpperCaseAny(packageExp);
}
protected void throwActionPackageHasUpperCaseException(ComponentDef actionDef, String actionName) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("The package name of the action has upper case.");
br.addItem("Advice");
br.addElement("Cannot use upper case in action package.");
br.addElement("Lower cases are only allowed like this:");
br.addElement(" (x):");
br.addElement(" seaLand.SeaLandAction // *Bad: sea[L]and");
br.addElement(" (o):");
br.addElement(" sealand.SealandAction => /sealand/");
br.addElement(" sea.SeaLandAction => /sea/land/");
br.addElement(" sea.land.SeaLandAction => /sea/land/");
br.addElement(" SeaLandAction => /sea/land/");
br.addItem("Illegal Action");
br.addElement(actionName);
br.addItem("Component Def");
br.addElement(actionDef);
final String msg = br.buildExceptionMessage();
throw new ActionPackageHasUpperCaseException(msg);
}
protected ActionMapping newActionMapping(ComponentDef actionDef, String actionName, ActionAdjustmentProvider adjustmentProvider) {
return new ActionMapping(actionDef, actionName, adjustmentProvider);
}
protected String buildFieldFormKey(ComponentDef actionDef) {
return buildActionName(actionDef) + "_Form"; // e.g. member_memberListAction_Form
}
// ===================================================================================
// Set up Method
// =============
protected void setupMethod(ActionMapping actionMapping) {
final Class actionType = actionMapping.getActionDef().getComponentClass();
for (Method declaredMethod : actionType.getDeclaredMethods()) {
if (!isExecuteMethod(declaredMethod)) {
continue;
}
final ActionExecute existing = actionMapping.getActionExecute(declaredMethod);
if (existing != null) {
throwOverloadMethodCannotDefinedException(actionType);
}
actionMapping.registerExecute(createActionExecute(actionMapping, declaredMethod));
}
verifyExecuteMethodSize(actionMapping, actionType);
verifyExecuteMethodNotShadowingOthers(actionMapping, actionType);
verifyExecuteMethodDefinedInConcreteClassOnly(actionMapping, actionType);
verifyExecuteMethodRestfulIndependent(actionMapping, actionType);
}
protected void throwOverloadMethodCannotDefinedException(final Class actionType) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("Cannot define overload method of action execute.");
br.addItem("Advice");
br.addElement("Same-name different-parameter method");
br.addElement("cannot be defined as execute method.");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse index() {");
br.addElement(" }");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse index(String sea) {");
br.addElement(" }");
br.addElement(" (o):");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse index() {");
br.addElement(" }");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse land(String sea) {");
br.addElement(" }");
br.addItem("Action");
br.addElement(actionType);
final String msg = br.buildExceptionMessage();
throw new ExecuteMethodIllegalDefinitionException(msg);
}
// -----------------------------------------------------
// Verify Definition
// -----------------
protected void verifyExecuteMethodSize(ActionMapping actionMapping, Class actionType) {
if (actionMapping.getExecuteMap().isEmpty()) {
throwExecuteMethodNotFoundInActionException(actionType);
}
}
protected void throwExecuteMethodNotFoundInActionException(Class actionType) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("Not found execute method in the action class.");
br.addItem("Advice");
br.addElement("Action class needs at least one method.");
br.addElement("Confirm the @Execute annotation of your execute method.");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" public HtmlResponse index() {");
br.addElement(" }");
br.addElement(" (o):");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse index() {");
br.addElement(" }");
br.addItem("Action");
br.addElement(actionType);
final String msg = br.buildExceptionMessage();
throw new ExecuteMethodIllegalDefinitionException(msg);
}
protected void verifyExecuteMethodNotShadowingOthers(ActionMapping actionMapping, Class actionType) {
final Map executeMap = actionMapping.getExecuteMap();
executeMap.values().stream().filter(execute -> {
// if urlPattern is specified, cannot determine shadowing so skip checking
return execute.isIndexMethod() // e.g. index() or get$index() or ...
&& execute.getPathParamArgs().isPresent() // no shadowing if no parameter
&& !execute.getPreparedUrlPattern().isSpecified();// cannot determine shadowing if specified
}).forEach(index -> {
if (index.getPathParamArgs().get().isNumberTypeParameter(0)) { // Number has original pattern
return;
}
// index may have String as the first argument without urlPattern here
// e.g.
// index(String sea) or get$index(String sea) or index(String sea, Integer ...)
// or index(LocalDate sea) or index(CDef.MemberStatus sea) or ...
executeMap.values().stream().filter(execute -> !execute.isIndexMethod()).filter(named -> { // named execute
return !isDifferentRestfulHttpMethod(index, named); // except e.g. index:GET, named:POST
}).forEach(named -> { // e.g. dockside() or dockside(String hangar) or ...
if (isShadowingExecuteMethod(index, named)) {
throwExecuteMethodShadowedByOtherExecuteMethodException(index, named);
}
});
});
}
protected boolean isShadowingExecuteMethod(ActionExecute index, ActionExecute named) {
// index() has one or more parameter(s) here
// and the first argument is not number and no urlPattern
// e.g.
// index(String sea)
// index(String sea, Integer land)
// and should return true if 100% shadowing only
if (named.getPreparedUrlPattern().isSpecified()) {
return false; // #giveup cannot determine shadowing for urlPattern
}
// both no urlPattern here
if (!named.getPathParamArgs().isPresent()) { // no parameter e.g. dockside()
return true; // shadowing if no urlPattern
}
// both has any parameters
return false; // #giveup also cannot determine shadowing for optional parameters
}
protected boolean isDifferentRestfulHttpMethod(ActionExecute index, ActionExecute named) {
return index.getRestfulHttpMethod().isPresent() && named.getRestfulHttpMethod().isPresent() // both has it
&& !index.getRestfulHttpMethod().get().equals(named.getRestfulHttpMethod().get()); // different
}
protected void throwExecuteMethodShadowedByOtherExecuteMethodException(final ActionExecute index, final ActionExecute execute) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("Shadowed the execute method by the other execute method.");
br.addItem("Advice");
br.addElement("Remove your the execute method shadowing others.");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse index(String name) {");
br.addElement(" }");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse sea() {");
br.addElement(" }");
br.addElement(" (o):");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse index(Integer id) {");
br.addElement(" }");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse sea() {");
br.addElement(" }");
br.addElement(" (o):");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse index() {");
br.addElement(" }");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse sea() {");
br.addElement(" }");
br.addItem("Index Execute");
br.addElement(index);
br.addItem("Named Execute");
br.addElement(execute);
final String msg = br.buildExceptionMessage();
throw new ExecuteMethodIllegalDefinitionException(msg);
}
protected void verifyExecuteMethodDefinedInConcreteClassOnly(ActionMapping actionMapping, Class actionType) {
for (Class clazz = actionType.getSuperclass(); !Object.class.equals(clazz); clazz = clazz.getSuperclass()) {
if (clazz == null) { // just in case
break;
}
for (Method declaredMethod : clazz.getDeclaredMethods()) {
if (isExecuteMethod(declaredMethod)) {
throwExecuteMethodAtSuperClassCannotBeDefinedException(clazz, declaredMethod);
}
}
}
}
protected void throwExecuteMethodAtSuperClassCannotBeDefinedException(Class clazz, Method declaredMethod) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("Cannot define execute method at super class.");
br.addItem("Advice");
br.addElement("Execute method should be defined at concrete class.");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" public abstract class SeaBaseAction ... {");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse index() {");
br.addElement(" }");
br.addElement(" }");
br.addElement(" (o):");
br.addElement(" public class SeaAction ... {");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse index() {");
br.addElement(" }");
br.addElement(" }");
br.addItem("Super Class");
br.addElement(clazz);
br.addItem("Illegal Execute");
br.addElement(declaredMethod);
final String msg = br.buildExceptionMessage();
throw new ExecuteMethodIllegalDefinitionException(msg);
}
protected void verifyExecuteMethodRestfulIndependent(ActionMapping actionMapping, Class actionType) {
final Map executeMap = actionMapping.getExecuteMap();
for (Entry entry : executeMap.entrySet()) {
final ActionExecute execute = entry.getValue();
if (execute.getRestfulHttpMethod().isPresent()) { // e.g. get$index
final ActionExecute plainMethod = executeMap.get(execute.getMappingMethodName()); // e.g. index
if (plainMethod != null) { // conflict, e.g. both index() and get$index() exist
throwExecuteMethodRestfulConflictException(actionType, execute, plainMethod);
}
}
}
}
protected void throwExecuteMethodRestfulConflictException(Class actionType, ActionExecute restfulMethod, ActionExecute plainMethod) {
final ExceptionMessageBuilder br = new ExceptionMessageBuilder();
br.addNotice("Conflicted the execute methods between restful and plain.");
br.addItem("Advice");
br.addElement("You cannot define restful method with same-name plain method.");
br.addElement("For example:");
br.addElement(" (x):");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse index() { // *Bad");
br.addElement(" }");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse get$index() { // *Bad");
br.addElement(" }");
br.addElement(" (o):");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse sea() { // Good");
br.addElement(" }");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse get$index() {");
br.addElement(" }");
br.addElement(" (o):");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse index() {");
br.addElement(" }");
br.addElement(" @Execute");
br.addElement(" public HtmlResponse get$sea() { // Good");
br.addElement(" }");
br.addItem("Action");
br.addElement(actionType);
br.addItem("Restful Method");
br.addElement(restfulMethod);
br.addItem("Plain Method");
br.addElement(plainMethod);
final String msg = br.buildExceptionMessage();
throw new ExecuteMethodIllegalDefinitionException(msg);
}
// ===================================================================================
// Action Execute
// ==============
protected ActionExecute createActionExecute(ActionMapping actionMapping, Method executeMethod) {
final Execute anno = getExecuteAnnotation(executeMethod); // exists, already checked
final ExecuteOption executeOption = createExecuteOption(anno);
return newActionExecute(actionMapping, executeMethod, executeOption);
}
protected Execute getExecuteAnnotation(Method executeMethod) {
return executeMethod.getAnnotation(Execute.class);
}
protected ExecuteOption createExecuteOption(Execute anno) {
final String urlPattern = anno.urlPattern();
final boolean suppressTransaction = anno.suppressTransaction();
final boolean suppressValidatorCallCheck = anno.suppressValidatorCallCheck();
final int sqlExecutionCountLimit = anno.sqlExecutionCountLimit();
return new ExecuteOption(urlPattern, suppressTransaction, suppressValidatorCallCheck, sqlExecutionCountLimit);
}
protected ActionExecute newActionExecute(ActionMapping actionMapping, Method executeMethod, ExecuteOption executeOption) {
return new ActionExecute(actionMapping, executeMethod, executeOption);
}
protected boolean isExecuteMethod(Method actionMethod) {
return LdiModifierUtil.isPublic(actionMethod) && getExecuteAnnotation(actionMethod) != null;
}
// ===================================================================================
// Component
// =========
protected ModuleConfig getModuleConfig() {
return LaModuleConfigUtil.getModuleConfig();
}
protected ActionAdjustmentProvider comeOnAdjustmentProvider() {
final FwAssistantDirector director = ContainerUtil.getComponent(FwAssistantDirector.class);
final FwWebDirection direction = director.assistWebDirection();
return direction.assistActionAdjustmentProvider();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy