cn.home1.oss.lib.security.swagger.AfterOperationBuilderBuildPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oss-lib-security-spring-boot-1.4.1.RELEASE Show documentation
There is a newer version: 1.0.8.OSS
Show newest version
package cn.home1.oss.lib.security.swagger;

import static com.google.common.collect.Sets.newHashSet;
import static springfox.documentation.schema.ResolvedTypes.modelRefFactory;
import static springfox.documentation.spi.schema.contexts.ModelContext.returnValue;

import cn.home1.oss.lib.errorhandle.api.ResolvedError;
import cn.home1.oss.lib.swagger.ManualRequestHandler;
import cn.home1.oss.lib.swagger.model.ApiOperationInfo;

import com.fasterxml.classmate.TypeResolver;

import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;

import springfox.documentation.RequestHandler;
import springfox.documentation.builders.OperationBuilder;
import springfox.documentation.builders.ResponseMessageBuilder;
import springfox.documentation.schema.ModelReference;
import springfox.documentation.schema.TypeNameExtractor;
import springfox.documentation.service.ResponseMessage;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.schema.contexts.ModelContext;
import springfox.documentation.spi.service.OperationBuilderPlugin;
import springfox.documentation.spi.service.contexts.OperationContext;
import springfox.documentation.spi.service.contexts.RequestMappingContext;
import springfox.documentation.swagger.common.SwaggerPluginSupport;

import java.lang.reflect.Field;
import java.util.Set;

/**
 * Created on 16/11/1.
 * Desc : Run after scanning operationBuilder plugin
 */
@Order(SwaggerPluginSupport.SWAGGER_PLUGIN_ORDER + 10)
@Slf4j
public class AfterOperationBuilderBuildPlugin implements OperationBuilderPlugin {

  private static final String MANUAL_REQUEST_HANDLER = ManualRequestHandler.class.getSimpleName();

  @Autowired
  private TypeResolver typeResolver;
  @Autowired
  private TypeNameExtractor nameExtractor;

  @Override
  public void apply(final OperationContext context) {
    try {
      // 处理自定义的请求处理器
      if (MANUAL_REQUEST_HANDLER.equals(context.getName())) {

        // get requestContext
        Field privateStringField = OperationContext.class.getDeclaredField("requestContext");
        privateStringField.setAccessible(true);
        final RequestMappingContext requestMappingContext = //
          (RequestMappingContext) privateStringField.get(context);

        // get handler
        privateStringField = RequestMappingContext.class.getDeclaredField("handler");
        privateStringField.setAccessible(true);
        final RequestHandler requestHandler = //
          (RequestHandler) privateStringField.get(requestMappingContext);

        if (requestHandler != null && requestHandler instanceof ManualRequestHandler) {
          final ManualRequestHandler manualRequestHandler = (ManualRequestHandler) requestHandler;
          final ApiOperationInfo apiOperationInfo = manualRequestHandler.getApiOperationInfo();

          if (apiOperationInfo != null) {
            // 接口描述
            context.operationBuilder().notes(apiOperationInfo.getNotes());
            // 请求参数处理
            if (apiOperationInfo.getApiRequest().getParameters() != null) {
              context.operationBuilder().parameters(apiOperationInfo.getApiRequest().getParameters());
            }
          }

        }
      }

      // 处理响应的错误码对应的ResolveError
      processResponseModel(context);
    } catch (final ReflectiveOperationException ex) {
      log.error("swagger plugin error.", ex);
    }
  }

  /**
   * 为错误码的响应增加Model的映射 @cn.home1.oss.lib.errorhandle.api.ResolvedError
   */
  private void processResponseModel(OperationContext context) {
    try {
      final OperationBuilder operationBuilder = context.operationBuilder();
      final Field privateStringField = OperationBuilder.class.getDeclaredField("responseMessages");
      privateStringField.setAccessible(true);
      final Set responseMessages = (Set) privateStringField.get(operationBuilder);

      final ModelContext modelContext = returnValue( //
        this.typeResolver.resolve(context.getReturnType()),
        context.getDocumentationType(),
        context.getAlternateTypeProvider(),
        context.getGenericsNamingStrategy(),
        context.getIgnorableParameterTypes());
      final ModelReference responseModel = modelRefFactory(modelContext, this.nameExtractor) //
        .apply(context.alternateFor(this.typeResolver.resolve(ResolvedError.class)));

      final Set responseMessagesProcessed = newHashSet();
      responseMessages.stream().forEach((responseMessage -> {
        if (!isSuccessful(responseMessage.getCode())) {
          responseMessagesProcessed.add(new ResponseMessageBuilder()
            .code(responseMessage.getCode())
            .message(responseMessage.getMessage())
            .responseModel(responseModel)
            .build());
        }
      }));
      if (!responseMessagesProcessed.isEmpty()) {
        context.operationBuilder().responseMessages(responseMessagesProcessed);
      }
    } catch (final NoSuchFieldException | IllegalAccessException ex) {
      log.info("error processResponseModel.", ex);
    }
  }

  /**
   * 判断是否是成功的响应.
   */
  private static boolean isSuccessful(final int code) {
    try {
      return HttpStatus.Series.SUCCESSFUL.equals(HttpStatus.Series.valueOf(code));
    } catch (final Exception ignored) {
      log.info("error check httpStatus {}.", code, ignored);
      return false;
    }
  }

  @Override
  public boolean supports(final DocumentationType delimiter) {
    return DocumentationType.SWAGGER_2.equals(delimiter);
  }
}