带有单页 angular2 重定向的 Spring Boot

Question

我有一个带有 Spring Boot 的单页 Angular 应用程序。如下所示：

src
  main
  java
    controller
       HomeController
       CustomerController
       OtherController
  webapp
    js/angular-files.js
    index.html

Spring boot 正确默认为 webapp 文件夹并提供 index.html 文件。

我想做的是：

1. 对于每个以/api 开头的本地 REST 请求不，覆盖并重定向到默认 webapp/index.html。我计划为弹簧控制器提供任何 /api 服务。

2. 有没有办法为所有控制器添加 API 前缀，这样我就不必每次都编写 API？ 例如

   @RequestMapping("/api/home") 可以在代码中写简写@RequestMapping("/home")

或

@RequestMapping("/api/other-controller/:id") can write shorthand  @RequestMapping("/other-controller/:id")

我正在寻找每个 API 请求，例如1) http://localhost:8080/api/home 保留 API 和 API 并解析正确的控制器并返回 JSON，但是如果有人输入像 http:///localhost/some-url 或 http:///localhost/some-other/123/url 这样的 URL，那么它将提供 index.html 页面并保留 URL。

其他方法：尝试添加#ErrorViewResolver： Springboot/Angular2 - How to handle HTML5 urls?

Answer 1

对于整个应用程序，您可以在 application.properties 中添加上下文路径

server.contextPath=/api

它会将“/api”附加到http://localhost:8080/api/home之后的每个请求的URL

对于重定向，

@Override
public void addViewControllers(ViewControllerRegistry registry) {
    registry.addRedirectViewController("/", "/home");
    registry.setOrder(Ordered.HIGHEST_PRECEDENCE);
    super.addViewControllers(registry);
}

把这一堆代码放到WebMVCConfig.java中

Answer 2

试试这个

@SpringBootApplication
@Controller
class YourSpringBootApp { 

    // Match everything without a suffix (so not a static resource)
    @RequestMapping(value = "/**/{path:[^.]*}")       
    public String redirect() {
        // Forward to home page so that route is preserved.(i.e forward:/intex.html)
        return "forward:/";
    }
}

Answer 3

对于不以 /api 开头的每个本地 REST 请求，覆盖并重定向到默认 webapp/index.html。我计划为 spring 控制器提供任何 /api 服务。

2017 年 5 月 15 日更新

让我为其他读者重新表述您的查询。 （如果有误解，请纠正我）

背景
使用 Spring Boot 并从类路径提供静态资源

要求
所有404 non api 请求都应该重定向到index.html。

NON API - 表示 URL 不以 /api 开头的请求。
API - 404 应该像往常一样抛出 404。

示例响应
/api/something - 将抛出404
/index.html - 将服务器index.html
/something - 将重定向到index.html

我的解决方案

如果给定资源没有任何处理程序可用，则让 Spring MVC 抛出异常。

添加关注application.properties

spring.mvc.throw-exception-if-no-handler-found=true
spring.resources.add-mappings=false

如下添加ControllerAdvice

@ControllerAdvice
public class RedirectOnResourceNotFoundException {

    @ExceptionHandler(value = NoHandlerFoundException.class)
    public Object handleStaticResourceNotFound(final NoHandlerFoundException ex, HttpServletRequest req, RedirectAttributes redirectAttributes) {
        if (req.getRequestURI().startsWith("/api"))
            return this.getApiResourceNotFoundBody(ex, req);
        else {
            redirectAttributes.addFlashAttribute("errorMessage", "My Custom error message");
            return "redirect:/index.html";
        }
    }

    private ResponseEntity<String> getApiResourceNotFoundBody(NoHandlerFoundException ex, HttpServletRequest req) {
        return new ResponseEntity<>("Not Found !!", HttpStatus.NOT_FOUND);
    }
}

您可以根据需要自定义错误消息。

有没有办法给所有控制器加上api前缀，这样我就不用每次都写api了。

为此，您可以创建一个BaseController 并将RequestMapping 路径设置为/api

示例

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RequestMapping("/api")
public abstract class BaseController {}

并扩展此 BaseController 并确保您不要使用 @RequestMapping 注释子类

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class FirstTestController extends BaseController {
    @RequestMapping(path = "/something")
    public String sayHello() {
        return "Hello World !!";
    }

}

上一个答案

你可以创建一个Filter，如果请求路径没有以/api开始，则重定向到/index.html。

// CODE REMOVED. Check Edit History If you want.

Answer 4

好的，让我们从问题的简单部分开始：

有没有办法给所有的控制器加上api前缀，这样我就不用每次都写api了？

答案是肯定的，只要给你的控制器打上“全局”@RequestMapping注解即可，例如：

@RestController
@RequestMapping("/api")
public class ApiController{

   @RequestMapping("/hello") 
   public String hello(){
      return "hello simple controller";
   }

   @RequestMapping("/hello2") 
   public String hello2(){
      return "hello2 simple controller";
   }
}

在上面的示例中，您可以使用以下 URL 调用 hello 方法：/api/hello

以及使用此 URL 的第二种方法：/api/hello2

这就是我不必用/api 前缀标记每个方法的原因。

现在，你的问题中更复杂的部分：

如果请求不以/api前缀开头，如何实现重定向？

您可以通过返回重定向的 HTTP 状态代码 (302) 来做到这一点，毕竟 angularJs 原生“说话” REST，因此您不能像以前那样强制从 Java/Spring 代码重定向。

然后只返回一个状态码为 302 的 HTTP 消息，然后在你的 angularJS 上进行实际的重定向。

例如：

在 AngularJS 上：

var headers = {'Content-Type':'application/json', 'Accept':'application/json'}

var config = {
    method:'GET'
    url:'http://localhost:8080/hello',
    headers:headers
};

http(config).then(
    function onSuccess(response){
        if(response.status == 302){
            console.log("Redirect");
            $location("/")
        }
}, function onError(response){
    console.log("An error occured while trying to open a new game room...");
});

春天：

@RestController
@RequestMapping("/api")
public class ApiController{

   @RequestMapping("/hello") 
   public ResponseEntity<String> hello(){
      HttpHeaders header = new HttpHeaders();
      header.add("Content-Type", "application/json");
      return new ResponseEntity<String>("", header, HttpStatus.FOUND);
   }
}

当然，您需要根据您的项目对其进行自定义。

Answer 5

您需要尝试的只是将index.html 放入src/main/resources/static/

参见示例： https://github.com/reflexdemon/shop/tree/master/src/main/resources/static

在我的package.josn 中，我尝试将其复制到此位置。

查看 PackageJSON： https://github.com/reflexdemon/shop/blob/master/package.json#L14

Answer 6

在@Configuration bean中你可以添加一个ServletRegistrationBean来为/api/* resquest创建spring服务器，然后在Controller中你不需要添加它。

@Bean
public ServletRegistrationBean dispatcherRegistration() {
    ServletRegistrationBean registration = new ServletRegistrationBean(
            dispatcherServlet());
    registration.addUrlMappings("/api/*");
    registration.setLoadOnStartup(1);
    registration.setName("mvc-dispatcher");
    return registration;
}

Answer 7

如果您厌倦了通过遵循这么多相互冲突的解决方案来解决这个问题 - 看这里！！

几小时后几小时后尝试遵循来自数十篇堆栈溢出和博客文章的所有分散建议，我终于找到了始终重定向到 index.html 的最小 PURE spring boot + angular 6 应用程序。在非根页面上刷新后的 html，同时维护所有 REST API 端点路径。没有@EnableWebMvc，没有@ControllerAdvice，没有更改application.properties，没有自定义ResourceHandlerRegistry 修改，只是简单：

非常重要的先决条件

你*必须*将ng build的输出包含到Spring的resources/static文件夹中。您可以通过maven-resources-plugin 完成此操作。在这里学习：Copying multiple resource directories to independent target directories with maven

代码

@Controller
@SpringBootApplication
public class MyApp implements ErrorController {

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

    private static final String PATH = "/error";

    @RequestMapping(value = PATH)
    public String error() {
        return "forward:/index.html";
    }

    @Override
    public String getErrorPath() {
        return PATH;
    }
}

推理

• 在构建时将 ng-build 的输出包含到 resources/static 中可以让 spring 视图重定向 ("forward:/index.html") 成功。似乎 spring 无法重定向到资源文件夹之外的任何内容，因此如果您尝试访问站点根目录下的页面，它将无法正常工作。
• 使用默认功能（即没有添加@EnableWebMvc 或更改application.properties）导航到/ 会自动提供index.html（如果它包含在resources/static 文件夹中），因此无需进行更改在那里。
• 使用默认功能（如上所述），在 Spring Boot 应用程序中遇到的任何错误都会路由到 /error 并实现 ErrorController 会覆盖该行为 - 你猜对了 - 路由到 index.html 允许 Angular 到接管路由。

备注

• 不要满足于 HashLocationStrategy 来解决这个问题，因为 Angular 不建议这样做：https://angular.io/guide/router#which-strategy-is-best

Answer 8

@Controller
public class RedirectController {
    /*
     * Redirects all routes to FrontEnd except: '/', '/index.html', '/api', '/api/**'
     */
    @RequestMapping(value = "{_:^(?!index\\.html|api).*$}")
    public String redirectApi() {
        return "forward:/";
    }
}

Answer 9

对我有用的解决方案是覆盖 Spring Boot 的 BasicErrorController：

@Component
public class CustomErrorController extends BasicErrorController {

    public CustomErrorController(ErrorAttributes errorAttributes) {
        super(errorAttributes, new ErrorProperties());
    }

    @RequestMapping(produces = "text/html")
    @Override
    public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
        HttpStatus status = getStatus(request);
        if (status == HttpStatus.NOT_FOUND) {
            return new ModelAndView("forward:/");
        } else {
            return super.errorHtml(request, response);
        }
    }
}

errorHtml 方法只拦截未找到的请求，对于来自 api 的响应 404（未找到）是透明的。

Answer 10

最合理的解决方案，恕我直言，对于 Spring Boot 2+（代码在 Kotlin 中）：

@Component
class ForwardErrorsToIndex : ErrorViewResolver {
   override fun resolveErrorView(request: HttpServletRequest?, 
                              status: HttpStatus?, 
                              model: MutableMap<String, Any>?): ModelAndView {
      return ModelAndView("forward:/index.html")
   }
}

Answer 11

在这个线程上为时已晚，但认为它可能对某人有所帮助

尝试了很多解决方案，但这对我来说看起来很简单而且很棒

import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.resource.PathResourceResolver;
 
import java.io.IOException;
 
@Configuration
public class MvcConfiguration implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**")
                .addResourceLocations("classpath:/static/")
                .resourceChain(true)
                .addResolver(new PathResourceResolver() {
                    @Override
                    protected Resource getResource(String resourcePath, Resource location) throws IOException {
                        Resource requestedResource = location.createRelative(resourcePath);
 
                        return requestedResource.exists() && requestedResource.isReadable() ? requestedResource
                                : new ClassPathResource("/static/index.html");
                    }
                });
    }
}

致谢：https://keepgrowing.in/java/springboot/make-spring-boot-surrender-routing-control-to-angular/