Rest Controller 在 Spring Boot App 中无法识别 GET 请求

Question

我正在尝试使用 Spring Boot 实现简单的演示 MVC 应用程序，但在执行该应用程序时出现 404 错误。 uri 是“http://localhost:8080/”，它显示 table 中的所有行，称为 circle.

Spring 引导：1.3.3.RELEASE
Java 版本：1.8.0_65
数据库：Apache Derby 10.12.1.1

Maven Java 项目：

Application.java

package com.nomad.dubbed.app;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application  {

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

}

CircleController.java

package com.nomad.dubbed.controller;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.nomad.dubbed.dao.CircleService;
import com.nomad.dubbed.model.Circle;

@RestController
@RequestMapping("/")
public class CircleController {
    @Autowired
    private CircleService circleService;

    @RequestMapping(method=RequestMethod.GET)
    public List<Circle> getAll() {
        return circleService.getAll();
    }

}

CircleRepository.java

package com.nomad.dubbed.dao;

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

import com.nomad.dubbed.model.Circle;

@Repository
public interface CircleRepository extends JpaRepository<Circle, Integer> {

}

CircleService.java

package com.nomad.dubbed.dao;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Propagation;
import org.springframework.transaction.annotation.Transactional;

import com.nomad.dubbed.model.Circle;

@Service
public class CircleService {
    @Autowired
    private CircleRepository circleRepository;

    @Transactional(propagation=Propagation.REQUIRED)
    public List<Circle> getAll(){
        return circleRepository.findAll();
    }

}

Circle.java

package com.nomad.dubbed.model;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;

@Entity
@Table(name="circle")
public class Circle {
    @Id
    @GeneratedValue(strategy=GenerationType.IDENTITY)
    private int id;
    private String name;

    public Circle(int id, String name) {
        super();
        this.id = id;
        this.name = name;
    }

    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }

}

application.properties

spring.datasource.url=jdbc:derby://localhost:1527/db
spring.datasource.driverClassName=org.apache.derby.jdbc.ClientDriver

logging.level.org.springframework.web:DEBUG
logging.level.org.hibernate:DEBUG

pom.xml

<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.nomad.dubbed</groupId>
  <artifactId>spring-boot-mvc</artifactId>
  <version>0.0.1-SNAPSHOT</version>


    <properties>
        <derby-client.version>10.11.1.1</derby-client.version>
    </properties>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.3.3.RELEASE</version>
        <relativePath />
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</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-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-remote-shell</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

        <dependency>
            <groupId>org.apache.derby</groupId>
            <artifactId>derbyclient</artifactId>
            <version>${derby-client.version}</version>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <finalName>spring-boot-mvc</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

数据库已启动运行，table 圈中有 5 行：

默认 uri（/beans、/health..）工作正常，但无法识别已实现的控制器。控制台中没有显示此类错误，下面是我发送请求后控制台打印的日志转储。

2016-05-03 14:17:26.594 DEBUG 659 --- [nio-8080-exec-3] o.s.web.servlet.DispatcherServlet        : DispatcherServlet with name 'dispatcherServlet' processing GET request for [/]
2016-05-03 14:17:26.596 DEBUG 659 --- [nio-8080-exec-3] s.w.s.m.m.a.RequestMappingHandlerMapping : Looking up handler method for path /
2016-05-03 14:17:26.596 DEBUG 659 --- [nio-8080-exec-3] s.w.s.m.m.a.RequestMappingHandlerMapping : Did not find handler method for [/]
2016-05-03 14:17:26.597 DEBUG 659 --- [nio-8080-exec-3] o.s.w.s.handler.SimpleUrlHandlerMapping  : Matching patterns for request [/] are [/**]
2016-05-03 14:17:26.597 DEBUG 659 --- [nio-8080-exec-3] o.s.w.s.handler.SimpleUrlHandlerMapping  : URI Template variables for request [/] are {}
2016-05-03 14:17:26.597 DEBUG 659 --- [nio-8080-exec-3] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapping [/] to HandlerExecutionChain with handler [ResourceHttpRequestHandler [locations=[ServletContext resource [/], class path resource [META-INF/resources/], class path resource [resources/], class path resource [static/], class path resource [public/]], resolvers=[org.springframework.web.servlet.resource.PathResourceResolver@6c13019c]]] and 1 interceptor
2016-05-03 14:17:26.597 DEBUG 659 --- [nio-8080-exec-3] o.s.web.servlet.DispatcherServlet        : Last-Modified value for [/] is: -1
2016-05-03 14:17:26.597 DEBUG 659 --- [nio-8080-exec-3] o.s.web.servlet.DispatcherServlet        : Null ModelAndView returned to DispatcherServlet with name 'dispatcherServlet': assuming HandlerAdapter completed request handling
2016-05-03 14:17:26.597 DEBUG 659 --- [nio-8080-exec-3] o.s.web.servlet.DispatcherServlet        : Successfully completed request
2016-05-03 14:17:26.597 DEBUG 659 --- [nio-8080-exec-3] o.s.web.servlet.DispatcherServlet        : DispatcherServlet with name 'dispatcherServlet' processing GET request for [/error]
2016-05-03 14:17:26.600 DEBUG 659 --- [nio-8080-exec-3] s.w.s.m.m.a.RequestMappingHandlerMapping : Looking up handler method for path /error
2016-05-03 14:17:26.600 DEBUG 659 --- [nio-8080-exec-3] s.w.s.m.m.a.RequestMappingHandlerMapping : Returning handler method [public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)]
2016-05-03 14:17:26.600 DEBUG 659 --- [nio-8080-exec-3] o.s.web.servlet.DispatcherServlet        : Last-Modified value for [/error] is: -1
2016-05-03 14:17:26.601 DEBUG 659 --- [nio-8080-exec-3] o.s.w.s.v.ContentNegotiatingViewResolver : Requested media types are [text/html, text/html;q=0.8] based on Accept header types and producible media types [text/html])
2016-05-03 14:17:26.601 DEBUG 659 --- [nio-8080-exec-3] o.s.w.s.v.ContentNegotiatingViewResolver : Returning [org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration$SpelView@2f5f8d71] based on requested media type 'text/html'
2016-05-03 14:17:26.601 DEBUG 659 --- [nio-8080-exec-3] o.s.web.servlet.DispatcherServlet        : Rendering view [org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration$SpelView@2f5f8d71] in DispatcherServlet with name 'dispatcherServlet'
2016-05-03 14:17:26.601 DEBUG 659 --- [nio-8080-exec-3] o.s.web.servlet.DispatcherServlet        : Successfully completed request

Answer 1

能否尝试添加 @ResponseBody 注释

@RequestMapping(method=RequestMethod.GET)
@ResponseBody
    public List<Circle> getAll() {
        return circleService.getAll();
    }

Answer 2

为您的控制器使用不同的 url。 spring-boot 中的“/”映射到位于 META-INF/resources 和 src/main/resources/static/ 中的静态资源。

编辑：忘记上面的内容并在您的应用程序中执行以下操作 class：

Application.java

package com.nomad.dubbed.app;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@ComponentScan("com.nomad.dubbed")
public class Application  {

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

}

spring-boots 组件扫描未发现您的休息控制器。根据此文档 http://docs.spring.io/spring-boot/docs/current/reference/html/… spring 扫描带有 @SpringBootApplication 注释的 class 所在的包下方的包。您的控制器位于并行包中。

Answer 3

我必须研究更多原因 spring - 引导无法识别具有原始包结构的控制器。我把所有的java class都打包成一个包，最后得到了演示项目运行。

已修改 Java 项目结构：

CircleController.java class 也修改了。圈子table的所有记录我都删了，没有说具体的请求方法，method=RequestMethod.GET.

package com.nomad.dubbed.app;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class CircleController {
    @Autowired
    private CircleService circleService;

    @RequestMapping(value="/circles", method=RequestMethod.GET)
    public List<Circle> getAll() {
        return circleService.getAll();
    }

}

Answer 4

我有同样的问题，我在应用程序 class 中添加了 @ComponentScan(basePackages = "package.name")。之后我的休息控制器被识别出来了。

包 com.nomad.dubbed.app;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@ComponentScan(basePackages = "com.spring.basepkg")
public class Application  {

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

}

Answer 5

在我看来，当我们将组件扫描留给 Spring 时，这个可见性问题就会出现，Spring 有一种使用标准约定查找 classes 的特定方式。在这种情况下，因为 Starter class(Application) 在 com.nomad.dubbed.app 包中，将 Controller 放在下一级将有助于 Spring 使用默认组件扫描机制找到 classes .将 CircleController 置于 com.nomad.dubbed.app.controller 下应该可以解决问题。

Answer 6

我遇到了类似的问题。在应用程序 class 上添加注释 @SpringBootApplication(scanBasePackages={"com.nomad.dubbed"}) 对我有用。

Answer 7

这就是后面发生的事情。

@SpringBootApplication注解是@Configuration@EnableAutoConfiguration@ComponentScan.

的组合没有参数的

@ComponentScan 告诉框架在同一个包中找到 components/beans 及其 sub-packages。

你的Application class注解@SpringBootApplication在包com.nomad.dubbed.app中。因此它会扫描该包及其下的 sub-packages（如 com.nomad.dubbed.app.*）。但是您的 CircleController 位于包 com.nomad.dubbed.controller 内，默认情况下不会扫描。您的存储库也不在默认扫描包范围内，因此 spring 框架也不会发现它们。

那现在怎么办？，你有两个选择。

选项 1

将Application class移动到顶级目录（包）。在你的情况下 com.nomad.dubbed 包。然后，由于所有控制器和其他存储库都在 sub-packages 中，它们将被框架发现。

选项 2

使用带有 basePackages 参数的 @ComponentScan 注释，以及 Application class 中的 @SpringBootApplication，如下所示。

@SpringBootApplication
@ComponentScan(basePackages="com.nomad.dubbed")
public class Application  {

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

Answer 8

我们不应将 @ComponentScan 注释与 @SpringBootApplication 一起使用，因为这不是正确的做法。 @SpringBootApplication 是 3 个注释的组合：@ComponentScan、@EnableAutoConfiguration 和 @Configuration.

具有 @SpringBootApplication 注释的主要 class 应该在 parent/super 包中。

例如 - com.spring.learning 是一个父包，它的子包是 com.spring.learning.controller、com.spring.learning.service、com.spring.learning.pojo

因此它会扫描它的包和子包。

这是最佳实践——项目布局或结构是 Spring Boot 中的重要概念。

Answer 9

实际上 springboots 会扫描核心包下的所有组件，例如：

包 com.nomad.dubbed.app;

如果在com.nomad.dubbed.app.controllers, com.nomad.dubbed.app.services, com.nomad.dubbed.app.dao.

下添加controller, services, dao packages

然后您可以轻松地运行您的其余控制器，但是如果您将所有包并行添加到您的核心 spring 引导包，例如 com.nomad.dubbed.controllers、com.nomad.dubbed.services.

然后你需要扫描@ComponentScan({"com.nomad.dubbed.controllers","com.nomad.dubbed.services"})

如果您选择使用 componentscan，那么您还必须扫描 springboot 应用程序包。

所以最好的方法是在 spring 引导应用程序 dubbed.app.xyz...

下创建所有包

Answer 10

请检查您的控制器 class 是否在子包中。

例如，如果主 class 是 com.myapp 包，那么控制器 class 要么在同一个包中，要么在像 com.myapp.controllers 这样的子包。 Spring 框架将扫描根包，然后扫描其所有子包。在这种情况下，一切都会正常进行，您不需要使用 @ComponentScan.

如果你把主要的 class 放在 com.myapp 和其他你想要自动装配的 beans/controllers 你放在不同的包里比如 com.beans 不是 com.myapp 的子包，那么你会遇到找不到 bean 的问题。

谢谢！巴格拉达

Rest Controller 在 Spring Boot App 中无法识别 GET 请求

Rest Controller not recognizing GET request in Spring Boot App

java

spring-mvc

maven

spring-boot

spring-restcontroller