io.micronaut.runtime.http.scope.RequestCustomScope Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-runtime Show documentation
Natively Cloud Native
There is a newer version: 4.7.9
/*
 * 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.runtime.http.scope;

import io.micronaut.core.annotation.Nullable;
import io.micronaut.context.BeanContext;
import io.micronaut.context.BeanResolutionContext;
import io.micronaut.context.LifeCycle;
import io.micronaut.context.event.ApplicationEventListener;
import io.micronaut.context.exceptions.NoSuchBeanException;
import io.micronaut.context.scope.CustomScope;
import io.micronaut.core.convert.value.MutableConvertibleValues;
import io.micronaut.core.util.ArgumentUtils;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.context.ServerRequestContext;
import io.micronaut.http.context.event.HttpRequestTerminatedEvent;
import io.micronaut.inject.BeanDefinition;
import io.micronaut.inject.BeanIdentifier;
import io.micronaut.inject.DisposableBeanDefinition;
import io.micronaut.inject.qualifiers.Qualifiers;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import io.micronaut.core.annotation.NonNull;
import javax.inject.Provider;
import javax.inject.Singleton;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;

/**
 * A {@link CustomScope} that creates a new bean for every HTTP request.
 *
 * @author James Kleeh
 * @author Marcel Overdijk
 * @since 1.2.0
 */
@Singleton
class RequestCustomScope implements CustomScope, LifeCycle, ApplicationEventListener {
    /**
     * The request attribute to store scoped beans in.
     */
    public static final String SCOPED_BEANS_ATTRIBUTE = "io.micronaut.http.SCOPED_BEANS";
    public static final String SCOPED_BEAN_DEFINITIONS_ATTRIBUTE = "io.micronaut.http.SCOPED_BEAN_DEFINITIONS";

    private static final Logger LOG = LoggerFactory.getLogger(RequestCustomScope.class);

    private final BeanContext beanContext;

    /**
     * Creates the request scope for the given context.
     *
     * @param beanContext The context
     */
    public RequestCustomScope(BeanContext beanContext) {
        this.beanContext = beanContext;
    }

    @Override
    public Class annotationType() {
        return RequestScope.class;
    }

    @Override
    public  T get(BeanResolutionContext resolutionContext, BeanDefinition beanDefinition,
                     BeanIdentifier identifier, Provider provider) {
        Optional> currentRequest = ServerRequestContext.currentRequest();
        if (!currentRequest.isPresent()) {
            throw new NoSuchBeanException(beanDefinition.getBeanType(), Qualifiers.byStereotype(RequestScope.class));
        }
        HttpRequest httpRequest = currentRequest.get();
        synchronized (httpRequest) {
            return (T) getRequestScopedBeans(httpRequest, true).computeIfAbsent(identifier, i -> {
                Object bean = provider.get();
                if (bean instanceof RequestAware) {
                    ((RequestAware) bean).setRequest(httpRequest);
                }
                getRequestScopedBeanDefinitions(httpRequest, true)
                        .put(identifier, beanDefinition);
                return bean;
            });
        }
    }

    @Override
    public  Optional remove(BeanIdentifier identifier) {
        Optional> request = ServerRequestContext.currentRequest();
        if (request.isPresent()) {
            T bean = (T) getRequestScopedBeans(request.get(), true).remove(identifier);
            BeanDefinition beanDefinition = (BeanDefinition) getRequestScopedBeanDefinitions(request.get(), true).remove(identifier);
            destroyRequestScopedBean(bean, beanDefinition);
            return Optional.ofNullable(bean);
        } else {
            return Optional.empty();
        }
    }

    private  void destroyRequestScopedBean(@Nullable T bean, @Nullable BeanDefinition beanDefinition) {
        if (bean != null && beanDefinition instanceof DisposableBeanDefinition) {
            try {
                ((DisposableBeanDefinition) beanDefinition).dispose(
                        beanContext, bean
                );
            } catch (Exception e) {
                if (LOG.isErrorEnabled()) {
                    LOG.error("Error disposing of request scoped bean: " + bean, e);
                }
            }
        }
    }

    @NonNull
    @Override
    public RequestCustomScope stop() {
        ServerRequestContext.currentRequest().ifPresent(this::destroyBeans);
        return this;
    }

    @Override
    public boolean isRunning() {
        return true;
    }

    @Override
    public void onApplicationEvent(HttpRequestTerminatedEvent event) {
        destroyBeans(event.getSource());
    }

    /**
     * Destroys the request scoped beans for the given request.
     * @param request The request
     */
    private void destroyBeans(HttpRequest request) {
        ArgumentUtils.requireNonNull("request", request);
        ConcurrentHashMap requestScopedBeans = getRequestScopedBeans(request, false);
        if (requestScopedBeans != null) {
            requestScopedBeans
                    .forEach((beanIdentifier, instance) -> {
                        BeanDefinition beanDefinition = getRequestScopedBeanDefinitions(request, false).get(beanIdentifier);
                        destroyRequestScopedBean(instance, beanDefinition);
                    });
        }
    }

    private  ConcurrentHashMap getRequestScopedBeans(HttpRequest httpRequest, boolean create) {
        synchronized (httpRequest) {
            return getRequestAttributeMap(httpRequest, SCOPED_BEANS_ATTRIBUTE, create);
        }
    }

    private  ConcurrentHashMap getRequestScopedBeanDefinitions(HttpRequest httpRequest, boolean create) {
        synchronized (httpRequest) {
            return getRequestAttributeMap(httpRequest, SCOPED_BEAN_DEFINITIONS_ATTRIBUTE, create);
        }
    }

    private  ConcurrentHashMap getRequestAttributeMap(HttpRequest httpRequest, String attribute, boolean create) {
        MutableConvertibleValues