cn.crane4j.annotation

注释类型 AutoOperate

@Target(value={METHOD,PARAMETER,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
public @interface AutoOperate

Declare the return value or parameter of the method(if the method is annotated by ArgAutoOperate) need process.

作者:

huangchengxing

另请参阅:

ArgAutoOperate, cn.crane4j.springboot.support.aop.MethodResultAutoOperateAspect, cn.crane4j.springboot.support.aop.MethodArgumentAutoOperateAspect

必需元素概要

所需元素

限定符和类型	必需的元素和说明
Class<?>	type The object type to be processed in the return value of the method.

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	condition The expression of apply condition.
String[]	excludes The group of operations not to be performed.
Class<?>	executor The type of the operation executor to be used.
String	executorName The name of the executor to be used.
String[]	includes The group of operations to be performed.
String	on When the return value is a wrapper class, we can specify to obtain the data set to be processed from the specific field of the wrapper class, and then process it。
Class<?>	parser The type of the operation parser to be used.
String	parserName The name of the operation parser to be used.
String	value When used in ArgAutoOperate, it is used to bind the corresponding parameter name.

元素详细资料

type

public abstract Class<?> type

The object type to be processed in the return value of the method. It will be parsed by the parser specified in parser() when it is first executed, and then the operation configuration will be obtained.

返回:

type to be processed

value

public abstract String value

When used in ArgAutoOperate, it is used to bind the corresponding parameter name.

返回:

parameter name

默认值:

""

on

public abstract String on

When the return value is a wrapper class, we can specify to obtain the data set to be processed from the specific field of the wrapper class, and then process it。

This configuration is generally used to process the method of returning the general response body in the Controller。
For example:

// general response
 public static class Result {
     private Integer code;
     private T data; // objects to be processed
 }
 // process general response

返回:

field name

默认值:

""

executor

public abstract Class<?> executor

The type of the operation executor to be used.

返回:

executor type

默认值:

java.lang.Object.class

executorName

public abstract String executorName

The name of the executor to be used.

返回:

executor name

默认值:

""

parser

public abstract Class<?> parser

The type of the operation parser to be used.

返回:

parser type

默认值:

java.lang.Object.class

parserName

public abstract String parserName

The name of the operation parser to be used.

返回:

parser name

默认值:

""

includes

public abstract String[] includes

The group of operations to be performed.
If it is blank, all operations will be performed by default.

返回:

group names

默认值:

{}

excludes

public abstract String[] excludes

The group of operations not to be performed.
The priority of this configuration is higher than includes()

返回:

group names

默认值:

{}

condition

public abstract String condition

The expression of apply condition. The operation will only be performed when the expression result is true or "true" string。

The following variables can be used by default in the expression：

• @beanName：beans in spring context；
• #parameterName: arguments of method；
• #result: return value of method；

返回:

expression of apply condition

另请参阅:

cn.crane4j.springboot.support.aop.MethodResultAutoOperateAspect#methodBaseExpressionEvaluator

默认值:

""