io.micronaut.function.web.AnnotatedFunctionRouteBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-function-web Show documentation
Show all versions of micronaut-function-web Show documentation
Core components supporting the Micronaut Framework
/*
* Copyright 2017-2020 original 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
*
* https://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 io.micronaut.function.web;
import io.micronaut.context.ExecutionHandleLocator;
import io.micronaut.context.annotation.Replaces;
import io.micronaut.context.annotation.Value;
import io.micronaut.context.processor.ExecutableMethodProcessor;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.convert.ConversionService;
import io.micronaut.core.naming.NameUtils;
import io.micronaut.core.reflect.ClassUtils;
import io.micronaut.core.type.Argument;
import io.micronaut.core.util.StringUtils;
import io.micronaut.function.DefaultLocalFunctionRegistry;
import io.micronaut.function.FunctionBean;
import io.micronaut.function.LocalFunctionRegistry;
import io.micronaut.http.MediaType;
import io.micronaut.http.annotation.Consumes;
import io.micronaut.http.annotation.Produces;
import io.micronaut.http.codec.MediaTypeCodec;
import io.micronaut.http.codec.MediaTypeCodecRegistry;
import io.micronaut.inject.BeanDefinition;
import io.micronaut.inject.ExecutableMethod;
import io.micronaut.web.router.DefaultRouteBuilder;
import io.micronaut.web.router.UriRoute;
import jakarta.inject.Singleton;
import java.net.URI;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.Consumer;
import java.util.function.Supplier;
import java.util.stream.Stream;
/**
* Process methods for {@link FunctionBean} instances.
*
* @author Graeme Rocher
* @since 1.0
*/
@Singleton
@Replaces(DefaultLocalFunctionRegistry.class)
public class AnnotatedFunctionRouteBuilder
extends DefaultRouteBuilder
implements ExecutableMethodProcessor, LocalFunctionRegistry, MediaTypeCodecRegistry {
private final LocalFunctionRegistry localFunctionRegistry;
private final String contextPath;
private final Map availableFunctions = new ConcurrentHashMap<>();
/**
* Constructor.
* @param executionHandleLocator executionHandleLocator
* @param uriNamingStrategy uriNamingStrategy
* @param conversionService conversionService
* @param codecRegistry codecRegistry
* @param contextPath contextPath
*/
public AnnotatedFunctionRouteBuilder(
ExecutionHandleLocator executionHandleLocator,
UriNamingStrategy uriNamingStrategy,
ConversionService conversionService,
MediaTypeCodecRegistry codecRegistry,
@Value("${micronaut.function.context-path:/}") String contextPath) {
super(executionHandleLocator, uriNamingStrategy, conversionService);
this.localFunctionRegistry = new DefaultLocalFunctionRegistry(codecRegistry);
this.contextPath = contextPath.endsWith("/") ? contextPath : contextPath + '/';
}
@SuppressWarnings("unchecked")
@Override
public void process(BeanDefinition beanDefinition, ExecutableMethod method) {
if (beanDefinition.hasAnnotation(FunctionBean.class)) {
String methodName = method.getMethodName();
Class declaringType = method.getDeclaringType();
String functionName = beanDefinition.stringValue(FunctionBean.class).orElse(methodName);
String functionMethod = beanDefinition.stringValue(FunctionBean.class, "method").orElse(null);
if (StringUtils.isNotEmpty(functionMethod) && !functionMethod.equals(methodName)) {
return;
}
List routes = new ArrayList<>(2);
MediaType[] consumes = Arrays.stream(method.stringValues(Consumes.class)).map(MediaType::of).toArray(MediaType[]::new);
MediaType[] produces = Arrays.stream(method.stringValues(Produces.class)).map(MediaType::of).toArray(MediaType[]::new);
boolean implementsFnInterface = false;
if (Stream.of(java.util.function.Function.class, Consumer.class, BiFunction.class, BiConsumer.class).anyMatch(type -> type.isAssignableFrom(declaringType))) {
implementsFnInterface = true;
if (methodName.equals("accept") || methodName.equals("apply")) {
String functionPath = resolveFunctionPath(methodName, declaringType, functionName);
String[] argumentNames = method.getArgumentNames();
String argumentName = argumentNames[0];
int argCount = argumentNames.length;
UriRoute route = POST(functionPath, beanDefinition, method);
routes.add(route);
if (argCount == 1) {
route.body(argumentName);
}
List> typeArguments = beanDefinition.getTypeArguments();
if (!typeArguments.isEmpty()) {
int size = typeArguments.size();
Argument firstArgument = typeArguments.get(0);
if (size < 3 && ClassUtils.isJavaLangType(firstArgument.getType()) && consumes.length == 0) {
consumes = new MediaType[] {MediaType.TEXT_PLAIN_TYPE, MediaType.APPLICATION_JSON_TYPE};
}
if (size < 3) {
route.body(Argument.of(firstArgument.getType(), argumentName));
}
if (size > 1) {
Argument argument = typeArguments.get(size == 3 ? 2 : 1);
if (ClassUtils.isJavaLangType(argument.getType()) && produces.length == 0) {
produces = new MediaType[] {MediaType.TEXT_PLAIN_TYPE, MediaType.APPLICATION_JSON_TYPE};
}
}
} else if (argCount == 1 && ClassUtils.isJavaLangType(method.getArgumentTypes()[0]) && consumes.length == 0) {
consumes = new MediaType[]{MediaType.TEXT_PLAIN_TYPE, MediaType.APPLICATION_JSON_TYPE};
}
}
}
if (routes.isEmpty() && Supplier.class.isAssignableFrom(declaringType)) {
implementsFnInterface = true;
if (methodName.equals("get")) {
String functionPath = resolveFunctionPath(methodName, declaringType, functionName);
routes.add(GET(functionPath, beanDefinition, method));
routes.add(HEAD(functionPath, beanDefinition, method));
}
}
if (routes.isEmpty() && (!implementsFnInterface || StringUtils.isNotEmpty(functionMethod))) {
// Only add a custom method when it's explicitly defined or if the bean doesn't implement known functional interface
Argument[] argumentTypes = method.getArguments();
int argCount = argumentTypes.length;
if (argCount < 3) {
String functionPath = resolveFunctionPath(methodName, declaringType, functionName);
if (argCount == 0) {
routes.add(GET(functionPath, beanDefinition, method));
routes.add(HEAD(functionPath, beanDefinition, method));
} else {
UriRoute route = POST(functionPath, beanDefinition, method);
routes.add(route);
if (argCount != 2 && ClassUtils.isJavaLangType(argumentTypes[0].getType())) {
route.body(method.getArgumentNames()[0])
.consumesAll();
}
}
}
}
if (!routes.isEmpty()) {
for (UriRoute route: routes) {
if (LOG.isDebugEnabled()) {
LOG.debug("Created Route to Function: {}", route);
}
route.consumes(consumes);
route.produces(produces);
}
String functionPath = resolveFunctionPath(methodName, declaringType, functionName);
availableFunctions.put(functionName, URI.create(functionPath));
((ExecutableMethodProcessor) localFunctionRegistry).process(beanDefinition, method);
}
}
}
private String resolveFunctionPath(String methodName, Class declaringType, String functionName) {
String functionPath = functionName;
if (StringUtils.isEmpty(functionPath)) {
String typeName = declaringType.getSimpleName();
if (typeName.contains("$")) {
// generated lambda
functionPath = contextPath + NameUtils.hyphenate(methodName);
} else {
functionPath = contextPath + NameUtils.hyphenate(typeName);
}
} else {
functionPath = contextPath + functionPath;
}
return functionPath;
}
/**
* A map of available functions with the key being the function name and the value being the function URI.
*
* @return A map of functions
*/
@Override
public Map getAvailableFunctions() {
return Collections.unmodifiableMap(availableFunctions);
}
@Override
public Optional> findFirst() {
return localFunctionRegistry.findFirst();
}
@Override
public Optional> find(String name) {
return localFunctionRegistry.find(name);
}
@Override
public Optional, T>> findSupplier(String name) {
return localFunctionRegistry.findSupplier(name);
}
@Override
public Optional, Void>> findConsumer(String name) {
return localFunctionRegistry.findConsumer(name);
}
@Override
public Optional, R>> findFunction(String name) {
return localFunctionRegistry.findFunction(name);
}
@Override
public Optional, R>> findBiFunction(String name) {
return localFunctionRegistry.findBiFunction(name);
}
@Override
public Optional findCodec(@Nullable MediaType mediaType) {
if (localFunctionRegistry instanceof MediaTypeCodecRegistry mediaTypeCodecRegistry) {
return mediaTypeCodecRegistry.findCodec(mediaType);
}
return Optional.empty();
}
@Override
public Optional findCodec(@Nullable MediaType mediaType, Class type) {
if (localFunctionRegistry instanceof MediaTypeCodecRegistry mediaTypeCodecRegistry) {
return mediaTypeCodecRegistry.findCodec(mediaType, type);
}
return Optional.empty();
}
@Override
public Collection getCodecs() {
if (localFunctionRegistry instanceof MediaTypeCodecRegistry mediaTypeCodecRegistry) {
return mediaTypeCodecRegistry.getCodecs();
}
return Collections.emptyList();
}
}