美文网首页我爱编程
Spring boot jersey + Jboss注意点

Spring boot jersey + Jboss注意点

作者: zjlxrong | 来源:发表于2018-03-30 22:15 被阅读1120次

    原本打算用spring mvc的,但想想配置太麻烦,所以就选择了spring boot。因公司要求要采用JAX-RS规范,所以用了jersey。 Spring boot已支持jersey,且提供了专门的依赖:spring-boot-start-jersey,所以整合起来比较简单。

    Spring boot:2.0.0.RELEASE

    JDK:1.8

    Jboss:7.0.4

    maven:3.3.3

    部署:打成war包,发布到jboss

    pom.xml

    因为要打成war包,所以在pom.xml中加上如下代码:
    <packaging>war</packaging>

    因为有父modules,所以用下面的方式引入spring boot的父依赖,同时也附上了一些主要的依赖,详细介绍可以参考官网

    <dependencyManagement>
            <dependencies>
            <dependency>
                <!-- Import dependency management from Spring Boot -->
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.0.0.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    
    <dependencies>
        <!-- Add typical dependencies for a web application -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
          <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jersey</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
            <!-- 因为要部署到jboss,所以要把内置的tomcat去掉 -->
            <!-- 官网的描述:To build a war file that is both executable and deployable into an external container, you need to mark the embedded container dependencies as “provided”-->
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    

    application.properties

    路径:src/java/resources
    Spring boot的默认配置文件是application.properties。

    数据源是用jndi,下面是spring boot中jndi的配置

    spring.datasource.jndi-name=java:jboss/datasources/customers
    

    引入了jersey, 可以使用下面的配置来定义jersey请求的路径

    # Path that serves as the base URI for the application.
    spring.jersey.application-path=/jersey
    

    Spring boot自身提供了一些Endpoint, 可以利用这些Endpoint可以查看Spring boot一些自动配置的信息、beans、health等等,帮助开发者学习Spring boot的一些自动配置及监控我们的Application。默认的路径是/actuator,如:/actuator/health, /actuator/beans。有些Endpoint是安全控制的,需要特殊配置,具体可以参考官网。可以在properties里面配置下面参数来改变默认路径:

    management.endpoints.web.base-path=/manage
    

    如果要用这些自带的Endpoint,需要在pom.xml中加入下面的依赖:

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

    介绍这2个路径的配置是为了引入一个问题,在Spring boot 2.0.0之前的版本,自带的Endpoint默认路径是/ *, 而jersey的默认路径也是/ *。自带的Endpoint是基于Spring MVC dispatcher,jersey是基于jersey dispatcher. 如果2个根路径是一样的话,Spring boot就有可能不知道请求要基于哪个dispatcher来处理,进而报错。最新版本应该没有这个问题,因为Spring boot已经给自带的Endpoint的默认路径改为/actuator。

    Jersey注册自定义的Endpoint

    Jersey注入

    @Component
    public class JerseyConfig extends ResourceConfig {
        public JerseyConfig() {
            register(Endpoint.class);
        }
    }
    

    Endpoint

    基于目前的配置,该URL:host:port/[projectname]/jersy/hello

    @Component
    @Path("/hello")
    public class Endpoint {
        @GET
        public String message() {
            return "Hello";
        }
    }
    

    启动类

    下面这段是引处官网的,我的理解:没有用内置的tomcat做部署,所以得重写configure方法,把外部的web容器上下文引入。

    The first step in producing a deployable war file is to provide a SpringBootServletInitializer subclass and override its configure method. Doing so makes use of Spring Framework’s Servlet 3.0 support and lets you configure your application when it is launched by the servlet container. Typically, you should update your application’s main class to extend SpringBootServletInitializer, as shown in the following example:

    @SpringBootApplication
    public class Application extends SpringBootServletInitializer {
        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
            return application.sources(Application.class);
        }
        public static void main(String[] args) throws Exception {
            SpringApplication.run(Application.class, args);
        }
    }
    

    Spring Boot会自动扫描@SpringBootApplication所在类的同级包及下级包里的所有bean,所以建议启动类放在最外层的包下。

    jboss相关配置

    位置:src/main/webapp/WEB-INF

    jboss-web.xml

    配置web context信息,web context是URL的根目录。若不配,默认项目名为web context。 如下是配置的例子,那么根URL为:host:port/demo/

    <!DOCTYPE jboss-web PUBLIC "-//JBoss//DTD Web Application 5.0//EN"  
    "http://www.jboss.org/j2ee/dtd/jboss-web_5_0.dtd">  
    <jboss-web>  
        <context-root>demo</context-root> 
    </jboss-web>    
    
    

    jboss-deployment-structure.xml

    jboss中,自带了一些jar包,spring boot项目中会用到一些jboss中自带的jar包,但项目中用的jar版本可能和jboss中自带的jar不匹配,代码部署到jboss,启动过程中会报一些类找不到的错误。

    有两种解决办法:

    1. 改jboss中的jar包,使之与项目匹配

    2. 在项目中添加jboss-deployment-structure.xml,exclude jboss中那些版本不匹配的jar包,再在项目中的pom.xml添加exclude掉的正确版本的jar依赖:

    <?xml version="1.0" encoding="UTF-8"?>    
    <jboss-deployment-structure>    
        <deployment>    
            <!-- Exclusions allow you to prevent the server from automatically adding some dependencies     -->    
            <exclusions>   
              <module name=“com.fasterxml.jackson.core.jackson-core” />
              <module name=“com.fasterxml.jackson.core.jackson-annotations” />
              <module name=“com.fasterxml.jackson.core.jackson-data bind” />
              <module name=“com.fasterxml.jackson.jaxrs.jackson-jaxrs-Jason-provider” />
              <module name=“org.jboss.resteasy.resteasy-jackson2-provider” />
              <module name=“org.jboss.resteasy.resteasy-jackson-provider” />
              <module name="javax.ws.rs.api"/>      
            </exclusions>    
        </deployment>    
    </jboss-deployment-structure>   
    

    当然,这两种方法可能都会引起其他相关联jar的版本冲突,需要一一排查

    调用ejb

    在代码里调用remote ejb,启动jboss时,发现一些ClassCastException。这个异常,还是因为包冲突引起的。
    在上一步中,exclude掉了jboss中自带的javax.ws.rs-api,在pom.xml里又引入了该jar的2.1版本,导致jboss中ejb用到的相关class与新版本的javax.ws.rs-api中的class冲突。
    因不想再处理这些包冲突,也因jboss中的ejb还有其他application在用,所以干脆降低了springboot版本为1.5.8,去掉上一步中的<module name="javax.ws.rs.api"/>这句代码(不引入新版本jar,直接使用jboss自带的javax.ws.rs-api.jar),问题就解决了。

    总结:经常解决完问题后,过些日子就忘记了,年纪大了,不得不服老呀!所以整理一下记下来,也许能利己也利各方码农呢...

    相关文章

      网友评论

        本文标题:Spring boot jersey + Jboss注意点

        本文链接:https://www.haomeiwen.com/subject/zqfwcftx.html