Spring boot jersey + Jboss注意点

原本打算用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),问题就解决了。

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,884评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,755评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,369评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,799评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,910评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,096评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,159评论 3 411
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,917评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,360评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,673评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,814评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,509评论 4 334
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,156评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,882评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,123评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,641评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,728评论 2 351

推荐阅读更多精彩内容