集成Primefaces(JSF)的Spring Boot项目如何配置实现REST端点开发

1. 必要依赖 #

首先确保项目引入核心依赖，Maven配置参考：

<!-- Spring Boot Web 依赖，包含DispatcherServlet -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- JoinFaces PrimeFaces starter，简化JSF/PrimeFaces集成 -->
<dependency>
    <groupId>org.joinfaces</groupId>
    <artifactId>primefaces-spring-boot-starter</artifactId>
    <version>5.2.3</version>
</dependency>

2. 核心Servlet路径隔离配置 #

通过配置类将两个Servlet映射到完全独立的路径前缀，避免请求冲突：

import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.DispatcherServlet;
import javax.faces.webapp.FacesServlet;

@Configuration
public class DualServletConfig {

    // FacesServlet 处理所有PrimeFaces/JSF请求，映射到/ui/*前缀
    @Bean
    public ServletRegistrationBean<FacesServlet> facesServletRegistration() {
        ServletRegistrationBean<FacesServlet> registration = new ServletRegistrationBean<>(new FacesServlet(), "/ui/*");
        registration.setName("FacesServlet");
        registration.setLoadOnStartup(1);
        return registration;
    }

    // DispatcherServlet 处理所有REST接口请求，映射到/api/*前缀
    @Bean
    public ServletRegistrationBean<DispatcherServlet> dispatcherServletRegistration(DispatcherServlet dispatcherServlet) {
        ServletRegistrationBean<DispatcherServlet> registration = new ServletRegistrationBean<>(dispatcherServlet, "/api/*");
        registration.setName("DispatcherServlet");
        registration.setLoadOnStartup(2);
        return registration;
    }
}

3. 基础配置补充 #

在application.properties中添加必要的JSF配置：

# JSF开发模式配置
joinfaces.jsf.project-stage=Development
# PrimeFaces主题配置可按需修改
joinfaces.primefaces.theme=luna-amber

4. 功能验证 #

• PrimeFaces页面验证：将.xhtml页面放置在src/main/resources/META-INF/resources/ui/目录下，启动项目后访问http://localhost:8080/ui/[页面名].xhtml即可正常加载PrimeFaces页面。
• REST接口验证：编写普通的RestController即可：

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

@RestController
public class DemoRestController {
    @GetMapping("/hello")
    public String hello() {
        return "REST接口调用成功";
    }
}

启动后访问http://localhost:8080/api/hello即可拿到返回结果，不会被FacesServlet拦截。

注意事项 #

• 两个Servlet的路径前缀不能重叠，否则会出现请求被错误拦截的问题
• 如果需要调整路径前缀，直接修改配置类中ServletRegistrationBean的路径参数即可

内容的提问来源于stack exchange，提问作者AguLongo