Skip to content

[DSIP-28] Donot scan whole project beans under classpath #15877

Closed
#15874
Closed
[DSIP-28] Donot scan whole project beans under classpath#15877
#15874
Assignees
ruanwenjun
Labels
DSIP
@ruanwenjun

Description

@ruanwenjun
ruanwenjun
opened on Apr 18, 2024

Search before asking

  • I had searched in the issues and found no similar feature requirement.

Motivation

Right now we will scan all beans under org.apache.dolphinscheduler in
AlertServer

dolphinscheduler/dolphinscheduler-alert/dolphinscheduler-alert-server/src/main/java/org/apache/dolphinscheduler/alert/AlertServer.java

Lines 45 to 48 in 325bfa8

@ComponentScan(value = "org.apache.dolphinscheduler", excludeFilters = {
@ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = JdbcRegistryAutoConfiguration.class)
})
public class AlertServer {

ApiServer

dolphinscheduler/dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/ApiApplicationServer.java

Lines 47 to 51 in 325bfa8

@ComponentScan(value = "org.apache.dolphinscheduler", excludeFilters = {
@ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = JdbcRegistryAutoConfiguration.class)
})
@Slf4j
public class ApiApplicationServer {

MasterServer

dolphinscheduler/dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/MasterServer.java

Lines 54 to 60 in 325bfa8

@ComponentScan(value = "org.apache.dolphinscheduler", excludeFilters = {
@ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = JdbcRegistryAutoConfiguration.class)
})
@EnableTransactionManagement
@EnableCaching
@Slf4j
public class MasterServer implements IStoppable {

WorkerServer.

dolphinscheduler/dolphinscheduler-worker/src/main/java/org/apache/dolphinscheduler/server/worker/WorkerServer.java

Lines 56 to 60 in 325bfa8

@ComponentScan(value = "org.apache.dolphinscheduler", excludeFilters = {
@ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = JdbcRegistryAutoConfiguration.class)
})
@Slf4j
public class WorkerServer implements IStoppable {

This will allow us to know the module relation difficultly, furthermore, if there exists an unexpected module in the application, the beans in this module will be loaded into memory, e.g. worker load dao module.

So it's better avoid scan whole project.

Design Detail

First, the application should only scan the package of the bootstrap class. Other package beans should be import by Configuration.

Second, the plugin beans should be registered by AutoConfiguration.

Compatibility, Deprecation, and Migration Plan

Compatibility with 3.x version.

Test Plan

Test by UT and E2E

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Metadata

Metadata

Assignees

Labels

DSIP

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions