其他包中的@RestController 不起作用答案

【问题标题】：@RestController in other package doesn't work其他包中的@RestController 不起作用
【发布时间】：2016-01-07 11:47:35
【问题描述】：

我从学习 Spring 开始，我创建了创建数据库、插入值并接下来在 Web 浏览器中打印它的基本项目。我的问题是，当我将 RestController 与主类一样放在同一个包中时 - 它可以，但我想将它分发到其他包，并且当我创建新包时，移动 RestController 它不起作用。让我们来解释一下：

我的项目如下：

          |-Springtestv_01
            |-src/main/java
              |--com.person <-- it's a main package
                 |-Main.java
                 |-Person.java
                 |-PersonLineRunner.java
                 |-PersonRepository.java
                 |-PersonController.java
              |-com.controller <-- second package, I want put here PersonController.java
            |-src/main/resources
              |-data.sql
            pom.xml

我的控制器看起来：

@RestController
public class PersonController {

    @Autowired PersonRepository personRepository;

    @RequestMapping("/persons")
    Collection<Person> persons(){
        return this.personRepository.findAll();
    }
}

当一切都在com.person 包中时，我在网络浏览器http://localhost:8080/persons 中写入，它可以正常工作... 但我想将PersonController.java 移动到com.controller 包，当我移动它时，我的浏览器会打电话给我

出现意外错误（类型=未找到，状态=404）。没有消息可用

我不知道我应该做什么来修复它。也许我应该在我的pom.xml 中更改一些内容？？

我的 pom.xml 看起来像

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.person</groupId>
    <artifactId>person</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>SpringTest_v0_1</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.3.0.BUILD-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.h2database</groupId><artifactId>h2</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>
                spring-boot-starter-data-elasticsearch
            </artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </pluginRepository>
        <pluginRepository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>

</project>

它是自动生成的，我只写了一个依赖

    <dependency>
        <groupId>com.h2database</groupId><artifactId>h2</artifactId>
    </dependency>

【问题讨论】：

请添加 spring context.xml
我猜你已经为包 com.person 定义了组件扫描，但没有为其他包定义。
在哪里可以为其他包装定义组件扫描？
你用的是spring-boot吗？你是用xml配置还是注解配置？
是的，我正在使用 spring-boot。我的配置在pom.xml

标签： java spring maven package spring-restcontroller

【解决方案1】：

使用基本包：

@ComponentScan(basePackages = { "com.person","com.controller"} )

【讨论】：

写在哪里？在我的Main.java 中？
@SpringBootApplication @ComponentScan({"com.person","com.controller"}) public class Main { public static void main(String[] args) { SpringApplication.run(Main.class, args); } } 我添加喜欢你看，它的工作原理！谢谢！ :)
变量basePackages 需要一些东西？
嗨，我想知道为什么以及何时需要添加类似这样的基本包以使用哪种注释？

【解决方案2】：

我遇到了同样的问题，这里提供的答案对我有用，但我必须添加另一个 spring 注释，并且在处理大量存储库的情况下它更通用。我们有以下结构：

 |-src/main/java
    |--com.person 
       |--repositories
       |--controllers
       |--...

然后应该将其添加到主目录中

@SpringBootApplication(scanBasePackages = {"com.person"}) 
@EnableMongoRepositories(basePackages = "com.person.repositories")
public class MainDemoApplication { //
}

【讨论】：

EnableMongoRepositories：这就是我要找的。span>

【解决方案3】：

使用@SpringBootApplication注解等同于使用@Configuration、@EnableAutoConfiguration和@ComponentScan。

来自文档：

ComponentScan 配置组件扫描指令以用于 @配置类。提供与 Spring XML 并行的支持元素。

basePackageClasses()、basePackages() 或其别名 value() 之一可以指定以定义要扫描的特定包。如果具体包未定义扫描将从类的包中发生这个注释。

您可以像以前一样移动它，也可以在@ComponentScan 中指定basePackages。

【讨论】：

【解决方案4】：

假设 main 方法位于名为 com.setech.app 的包中，而控制器位于名为 com.setech.controller 的包中。

对于 spring-boot 1.3.x 以上版本，可以通过像这样添加“scanBasePackages”来尝试。

@SpringBootApplication(scanBasePackages = { "com.setech"} )
public class ResttanslatorApplication {

    public static void main(String[] args) {

        SpringApplication.run(ResttanslatorApplication.class, args);
    }

}

感谢来自 here 的卡米尔·沃兹尼亚克。

【讨论】：

【解决方案5】：

我们可以使用@ComponentScan (basePackages = {"include your package name here"})。

另外，如果您有一些通用的包命名格式，那么我们可以将包名的通用部分包含在* 中，例如@ComponentScan(basePackages = { "com.*"}，这样所有具有该通用包名的包都会被扫描。

【讨论】：

【解决方案6】：

我遇到了同样的问题，但突然发现我的 Application.java 类（带有 main 方法和 @SpringBootApplication 注解的类）位于与 @Controller 类不同但并行的包中。

问题是 Application.java 类应该在所有其他包中或在所有其他包之上，然后我们不需要任何 @ComponentScan 并且所有 bean 都将被自动扫描。例如：如果 Application.java 位于 com.person 中，所有应用程序 bean 位于 com.person 中，那么它可以在没有 @ComponentScan 的情况下工作。

【讨论】：

这是我的首选解决方案。就我而言，我只是将 Application.java 向上移动一个目录，以自动扫描来自不同子包的两个控制器。

【解决方案7】：

对于 Maven 案例：如果你将控制器放在另一个不同的子模块中（与主类不同），你应该在 pom.xml 中添加依赖。

【讨论】：

【解决方案8】：

将 Springbootapplication(application.java) 文件移动到另一个包解决了我的问题。将其与控制器和存储库分开。您可以使用任意数量的包并拥有多个控制器。但请使用@ComponenScan(basePackages={" "," "}) 并提及所有包。

另外，你可能会遇到这个问题Consider defining a bean of type..点击here！

【讨论】：

【解决方案9】：

你只需要在 @ComponentScan 中定义一个包名喜欢：

@SpringBootApplication
@ComponentScan({"com.project.pck_name"})
public class MainClassHome {

    public static void main(String[] args) {
        SpringApplication.run(MainClassHome.class, args);
    }
}

然后更新项目：- 右键单击您的项目 -> maven -> 更新项目

【讨论】：

【解决方案10】：

我们可以使用 @Import 来代替 ComponentsScan。

@Configuration

@Import({PersonController.class})

public class MainClassHome {

    public static void main(String[] args) {
        SpringApplication.run(MainClassHome.class, args);
    }
}

【讨论】：

【解决方案11】：

作为一直在努力解决问题的人，如果您发现提供的解决方案不起作用。
请检查您是否将源文件直接放在根级别，例如，
src\main\java\xxx.java

对项目有负面影响，但我不知道根本原因。总之，

请将源文件至少放入一个自己创建的包中，例如： src\main\java\pack1\xxx.java

再次尝试其他设置。它确实解决了我的问题。

【讨论】：

【解决方案12】：

我发现，如果将 Controller 类放在单独的 jar 中，@Componentscan 找不到 @RestControllers。但是，@SpringBootApplication(scanBasePackages =.. 这个把戏做得更好。我使用了发布火车 springboot spring-cloud-starter-parent, Greenwich.SR4 这解决了 spring boot 2.1.10.Release 所以，在这个版本中，@SpringBootApplication @Componentscan 在这件事上的行为。

【讨论】：