在其他包中的@RestController不起作用。

39

我开始学习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包里时,我在Web浏览器中输入http://localhost:8080/persons,它可以正常工作... 但是,我想把PersonController.java移动到com.controller包中,在我移动它之后,我的浏览器会显示:

There was an unexpected error (type=Not Found, status=404). No message available

我不知道应该怎么修复它。也许我应该更改我的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文件。 - Natalia
1
我的猜测是你已经为包com.person定义了一个组件扫描,但没有为其他包定义。 - hotzst
我在哪里可以为其他包定义组件扫描? - CeZet
你正在使用spring-boot吗?你是在使用XML配置还是注解配置? - mhlz
1
是的,我正在使用spring-boot。我的配置在pom.xml文件中。 - CeZet
应该能够与SpringBoot一起使用 - Denys
12个回答

85

使用 basePackages:

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

5
写在哪里?在我的 Main.java 文件中吗? - CeZet
11
@SpringBootApplication @ComponentScan({"com.person","com.controller"}) public class Main { public static void main(String[] args) { SpringApplication.run(Main.class, args); } }我按照您的提示添加了代码,现在可以正常运行了!谢谢! :) - CeZet
变量 basePackages 需要做些什么? - CeZet
嗨,我想知道为什么和何时我们需要添加基础包,例如这样的包,以便使用哪种类型的注释? - Jasbin karki

8

我遇到了与这里提供的答案相同的问题,这些答案对我有用,但我必须添加另一个Spring注解,并且更加通用,以处理大量存储库。

我们有以下结构:

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

这应该添加在主要的代码中。
@SpringBootApplication(scanBasePackages = {"com.person"}) 
@EnableMongoRepositories(basePackages = "com.person.repositories")
public class MainDemoApplication { //
}

EnableMongoRepositories:这就是我一直在寻找的。 - Iqbal

6
使用@SpringBootApplication注解等同于使用@Configuration@EnableAutoConfiguration@ComponentScan
根据文档:

ComponentScan 为与 @Configuration 类一起使用配置组件扫描指令。提供与 Spring XML 的 element 平行的支持。

可以指定 basePackageClasses()、basePackages() 或其别名 value() 中的一个来定义要扫描的特定包,如果未定义特定包,则从具有此注释的类的包中进行扫描。

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

4
我们可以使用@ComponentScan (basePackages = {"在此处包括您的包名称"})
此外,如果您有一些常见的包命名格式,那么我们可以只包括包名称的公共部分,并使用*,如@ComponentScan(basePackages = { "com.*"},这样所有具有该公共包名称的包都将被扫描。

4

我曾经遇到过同样的问题,但突然发现我的Application.java类(带有main方法和@SpringBootApplication注解的类)与@Controller类位于不同但平行的包中。

问题在于Application.java类应该位于同一级别或所有其他包的顶部,这样我们就不需要任何@ComponentScan,所有bean都将自动扫描。例如:如果Application.java位于com.person中,所有应用程序bean位于com.person中,则无需@ComponentScan即可正常工作。


这是我首选的解决方案。在我的情况下,我只需将Application.java向上移动一个目录,以便自动扫描来自不同子包的两个控制器。 - Pam Stums

4

假设主方法在名为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);
    }

感谢Kamil Wozniak在这里的贡献。


2

Maven案例:如果您将控制器放在另一个不同的子模块中(与主类不同),则应在pom.xml中添加依赖项。


2
将Springboot应用程序文件(application.java)移动到另一个包中,解决了我的问题。请将其与控制器和存储库分开。您可以使用任意数量的包并拥有多个控制器。但要使用@ComponentScan(basePackages={" "," "})并提及所有包。
此外,您可能会遇到此问题Consider defining a bean of type..,请点击此处了解更多信息!

2

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


@Configuration

@Import({PersonController.class})

public class MainClassHome {

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

1
你只需要在@ComponentScan中定义一个包名,例如:
@SpringBootApplication
@ComponentScan({"com.project.pck_name"})
public class MainClassHome {

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

在此之后更新项目:右键单击您的项目 -> maven -> 更新项目。

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接