org.ssssssss.magicapi.spring.boot.starter

类 MagicAPIAutoConfiguration

java.lang.Object

org.ssssssss.magicapi.spring.boot.starter.MagicAPIAutoConfiguration

所有已实现的接口:

org.springframework.web.servlet.config.annotation.WebMvcConfigurer, org.springframework.web.socket.config.annotation.WebSocketConfigurer

@Configuration
 @ConditionalOnClass(value=org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping.class)
 @EnableConfigurationProperties(value=MagicAPIProperties.class)
 @Import(value={MagicRedisAutoConfiguration.class,MagicMongoAutoConfiguration.class,MagicSwaggerConfiguration.class,MagicJsonAutoConfiguration.class,ApplicationUriPrinter.class})
 @EnableWebSocket
public class MagicAPIAutoConfiguration
extends Object
implements org.springframework.web.servlet.config.annotation.WebMvcConfigurer, org.springframework.web.socket.config.annotation.WebSocketConfigurer

magic-api自动配置类

作者:

mxd

构造器概要

构造器

构造器和说明

MagicAPIAutoConfiguration(MagicAPIProperties properties, org.springframework.beans.factory.ObjectProvider<List<Dialect>> dialectsProvider, org.springframework.beans.factory.ObjectProvider<List<RequestInterceptor>> requestInterceptorsProvider, org.springframework.beans.factory.ObjectProvider<List<SQLInterceptor>> sqlInterceptorsProvider, org.springframework.beans.factory.ObjectProvider<List<org.ssssssss.script.functions.ExtensionMethod>> extensionMethodsProvider, org.springframework.beans.factory.ObjectProvider<List<org.springframework.http.converter.HttpMessageConverter<?>>> httpMessageConvertersProvider, org.springframework.beans.factory.ObjectProvider<List<ColumnMapperProvider>> columnMapperProvidersProvider, org.springframework.beans.factory.ObjectProvider<List<MagicFunction>> magicFunctionsProvider, org.springframework.beans.factory.ObjectProvider<MagicNotifyService> magicNotifyServiceProvider, org.springframework.beans.factory.ObjectProvider<AuthorizationInterceptor> authorizationInterceptorProvider, org.springframework.beans.factory.ObjectProvider<List<NamedTableInterceptor>> namedTableInterceptorsProvider, org.springframework.beans.factory.ObjectProvider<DataSourceEncryptProvider> dataSourceEncryptProvider, org.springframework.core.env.Environment environment, org.springframework.context.ApplicationContext applicationContext)

方法概要

限定符和类型	方法和说明
void	addInterceptors(org.springframework.web.servlet.config.annotation.InterceptorRegistry registry)
void	addResourceHandlers(org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry registry)
ApiServiceProvider	apiServiceProvider(GroupServiceProvider groupServiceProvider, Resource magicResource) 注入接口存储service
AuthorizationInterceptor	createAuthorizationInterceptor()
FunctionServiceProvider	functionServiceProvider(GroupServiceProvider groupServiceProvider, Resource magicResource)
GroupServiceProvider	groupServiceProvider(Resource magicResource) 注入分组存储service
JSR223LanguageProvider	jsr223LanguageProvider()
MagicAPIService	magicAPIService(MappingHandlerMapping mappingHandlerMapping, ApiServiceProvider apiServiceProvider, FunctionServiceProvider functionServiceProvider, GroupServiceProvider groupServiceProvider, ResultProvider resultProvider, MagicDynamicDataSource magicDynamicDataSource, MagicFunctionManager magicFunctionManager, Resource workspace, MagicBackupService magicBackupService) 注入API调用Service
MagicConfiguration	magicConfiguration(MagicDynamicDataSource dynamicDataSource, SQLModule sqlModule, List<MagicModule> magicModules, List<LanguageProvider> languageProviders, Resource magicResource, ResultProvider resultProvider, MagicAPIService magicAPIService, ApiServiceProvider apiServiceProvider, GroupServiceProvider groupServiceProvider, MappingHandlerMapping mappingHandlerMapping, FunctionServiceProvider functionServiceProvider, MagicNotifyService magicNotifyService, MagicFunctionManager magicFunctionManager, MagicBackupService magicBackupService)
org.springframework.boot.web.servlet.FilterRegistrationBean<MagicCorsFilter>	magicCorsFilterRegistrationBean()
MagicBackupService	magicDatabaseBackupService(MagicDynamicDataSource magicDynamicDataSource)
Resource	magicDatabaseResource(MagicDynamicDataSource magicDynamicDataSource)
MagicDynamicDataSource	magicDynamicDataSource(DataSource dataSource) 注入动态数据源
MagicBackupService	magicFileBackupService()
MagicFunctionManager	magicFunctionManager(GroupServiceProvider groupServiceProvider, FunctionServiceProvider functionServiceProvider)
HttpModule	magicHttpModule()
MagicNotifyService	magicNotifyService()
Resource	magicResource()
SQLModule	magicSqlModule(MagicDynamicDataSource dynamicDataSource, ResultProvider resultProvider, PageProvider pageProvider, SqlCache sqlCache) 注入数据库查询模块
MappingHandlerMapping	mappingHandlerMapping() 注入接口映射
PageProvider	pageProvider()
void	registerWebSocketHandlers(org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry webSocketHandlerRegistry)
ResultProvider	resultProvider() 注入结果构建方法
SqlCache	sqlCache() 注入SQL缓存实现

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.springframework.web.servlet.config.annotation.WebMvcConfigurer

addArgumentResolvers, addCorsMappings, addFormatters, addReturnValueHandlers, addViewControllers, configureAsyncSupport, configureContentNegotiation, configureDefaultServletHandling, configureHandlerExceptionResolvers, configureMessageConverters, configurePathMatch, configureViewResolvers, extendHandlerExceptionResolvers, extendMessageConverters, getMessageCodesResolver, getValidator

构造器详细资料

MagicAPIAutoConfiguration

public MagicAPIAutoConfiguration(MagicAPIProperties properties,
                                 org.springframework.beans.factory.ObjectProvider<List<Dialect>> dialectsProvider,
                                 org.springframework.beans.factory.ObjectProvider<List<RequestInterceptor>> requestInterceptorsProvider,
                                 org.springframework.beans.factory.ObjectProvider<List<SQLInterceptor>> sqlInterceptorsProvider,
                                 org.springframework.beans.factory.ObjectProvider<List<org.ssssssss.script.functions.ExtensionMethod>> extensionMethodsProvider,
                                 org.springframework.beans.factory.ObjectProvider<List<org.springframework.http.converter.HttpMessageConverter<?>>> httpMessageConvertersProvider,
                                 org.springframework.beans.factory.ObjectProvider<List<ColumnMapperProvider>> columnMapperProvidersProvider,
                                 org.springframework.beans.factory.ObjectProvider<List<MagicFunction>> magicFunctionsProvider,
                                 org.springframework.beans.factory.ObjectProvider<MagicNotifyService> magicNotifyServiceProvider,
                                 org.springframework.beans.factory.ObjectProvider<AuthorizationInterceptor> authorizationInterceptorProvider,
                                 org.springframework.beans.factory.ObjectProvider<List<NamedTableInterceptor>> namedTableInterceptorsProvider,
                                 org.springframework.beans.factory.ObjectProvider<DataSourceEncryptProvider> dataSourceEncryptProvider,
                                 org.springframework.core.env.Environment environment,
                                 org.springframework.context.ApplicationContext applicationContext)

方法详细资料

magicHttpModule

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.modules.HttpModule.class)
public HttpModule magicHttpModule()

magicDynamicDataSource

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.config.MagicDynamicDataSource.class)
public MagicDynamicDataSource magicDynamicDataSource(@Autowired(required=false)
                                                                                                                                                         DataSource dataSource)

注入动态数据源

magicDatabaseResource

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.adapter.Resource.class)
 @ConditionalOnProperty(prefix="magic-api",
                       name="resource.type",
                       havingValue="database")
public Resource magicDatabaseResource(MagicDynamicDataSource magicDynamicDataSource)

magicResource

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.adapter.Resource.class)
 @ConditionalOnProperty(prefix="magic-api",
                       name="resource.type",
                       havingValue="file",
                       matchIfMissing=true)
public Resource magicResource()
                                                                                                                                                                                                                                                                                                  throws IOException

抛出:

IOException

magicDatabaseBackupService

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.provider.MagicBackupService.class)
 @ConditionalOnProperty(prefix="magic-api",
                       name="backup-config.resource-type",
                       havingValue="database")
public MagicBackupService magicDatabaseBackupService(MagicDynamicDataSource magicDynamicDataSource)

addResourceHandlers

public void addResourceHandlers(org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry registry)

指定者:

addResourceHandlers 在接口中 org.springframework.web.servlet.config.annotation.WebMvcConfigurer

addInterceptors

public void addInterceptors(org.springframework.web.servlet.config.annotation.InterceptorRegistry registry)

指定者:

addInterceptors 在接口中 org.springframework.web.servlet.config.annotation.WebMvcConfigurer

magicCorsFilterRegistrationBean

@Bean
 @ConditionalOnProperty(prefix="magic-api",
                       value="support-cross-domain",
                       havingValue="true",
                       matchIfMissing=true)
public org.springframework.boot.web.servlet.FilterRegistrationBean<MagicCorsFilter> magicCorsFilterRegistrationBean()

pageProvider

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.provider.PageProvider.class)
public PageProvider pageProvider()

resultProvider

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.provider.ResultProvider.class)
public ResultProvider resultProvider()

注入结果构建方法

sqlCache

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.cache.SqlCache.class)
public SqlCache sqlCache()

注入SQL缓存实现

mappingHandlerMapping

@Bean
public MappingHandlerMapping mappingHandlerMapping()
                                                   throws NoSuchMethodException

注入接口映射

抛出:

NoSuchMethodException

functionServiceProvider

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.provider.FunctionServiceProvider.class)
public FunctionServiceProvider functionServiceProvider(GroupServiceProvider groupServiceProvider,
                                                                                                                                                              Resource magicResource)

groupServiceProvider

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.provider.GroupServiceProvider.class)
public GroupServiceProvider groupServiceProvider(Resource magicResource)

注入分组存储service

apiServiceProvider

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.provider.ApiServiceProvider.class)
public ApiServiceProvider apiServiceProvider(GroupServiceProvider groupServiceProvider,
                                                                                                                                               Resource magicResource)

注入接口存储service

magicNotifyService

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.provider.MagicNotifyService.class)
public MagicNotifyService magicNotifyService()

magicFileBackupService

@Bean
 @ConditionalOnMissingBean(value=org.ssssssss.magicapi.provider.MagicBackupService.class)
 @ConditionalOnProperty(prefix="magic-api",
                       name="backup-config.resource-type",
                       havingValue="file",
                       matchIfMissing=true)
public MagicBackupService magicFileBackupService()

magicFunctionManager

@Bean
public MagicFunctionManager magicFunctionManager(GroupServiceProvider groupServiceProvider,
                                                        FunctionServiceProvider functionServiceProvider)

magicAPIService

@Bean
 @ConditionalOnMissingBean
public MagicAPIService magicAPIService(MappingHandlerMapping mappingHandlerMapping,
                                                                          ApiServiceProvider apiServiceProvider,
                                                                          FunctionServiceProvider functionServiceProvider,
                                                                          GroupServiceProvider groupServiceProvider,
                                                                          ResultProvider resultProvider,
                                                                          MagicDynamicDataSource magicDynamicDataSource,
                                                                          MagicFunctionManager magicFunctionManager,
                                                                          Resource workspace,
                                                                          MagicBackupService magicBackupService)

注入API调用Service

magicSqlModule

@Bean
 @ConditionalOnBean(value=org.ssssssss.magicapi.config.MagicDynamicDataSource.class)
public SQLModule magicSqlModule(MagicDynamicDataSource dynamicDataSource,
                                                                                                                             ResultProvider resultProvider,
                                                                                                                             PageProvider pageProvider,
                                                                                                                             SqlCache sqlCache)

注入数据库查询模块

jsr223LanguageProvider

@Bean
public JSR223LanguageProvider jsr223LanguageProvider()

magicConfiguration

@Bean
public MagicConfiguration magicConfiguration(MagicDynamicDataSource dynamicDataSource,
                                                    SQLModule sqlModule,
                                                    List<MagicModule> magicModules,
                                                    List<LanguageProvider> languageProviders,
                                                    Resource magicResource,
                                                    ResultProvider resultProvider,
                                                    MagicAPIService magicAPIService,
                                                    ApiServiceProvider apiServiceProvider,
                                                    GroupServiceProvider groupServiceProvider,
                                                    MappingHandlerMapping mappingHandlerMapping,
                                                    FunctionServiceProvider functionServiceProvider,
                                                    MagicNotifyService magicNotifyService,
                                                    MagicFunctionManager magicFunctionManager,
                                                    MagicBackupService magicBackupService)
                                             throws NoSuchMethodException

抛出:

NoSuchMethodException

createAuthorizationInterceptor

public AuthorizationInterceptor createAuthorizationInterceptor()

registerWebSocketHandlers

public void registerWebSocketHandlers(org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry webSocketHandlerRegistry)

指定者:

registerWebSocketHandlers 在接口中 org.springframework.web.socket.config.annotation.WebSocketConfigurer