文档章节

Jersey2.x框架搭建简单的Restful API

centychen
 centychen
发布于 2016/09/18 17:27
字数 542
阅读 1533
收藏 47

Jersey2.x框架搭建简单的Restful API

最近想用Jersey框架搭建一个Restful API项目,上网找了一下教程,发现网上的demo都是直接使用class定义API,而个人的想法是使用interface定义API接口,具体业务实现都放在实现类中,折腾了一个上午,终于找到解决的方式。

具体步骤如下:

  • 创建Web项目(Maven)

image

  • 添加Jersey依赖
<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/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>org.cent.demo</groupId>
    <artifactId>jersey</artifactId>
    <packaging>war</packaging>
    <version>1.0-SNAPSHOT</version>
    <name>jersey Maven Webapp</name>
    <url>http://maven.apache.org</url>

    <properties>
        <jersey.version>2.23.2</jersey.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>3.8.1</version>
            <scope>test</scope>
        </dependency>

        <!-- jersey dependencies -->
        <dependency>
            <groupId>org.glassfish.jersey.core</groupId>
            <artifactId>jersey-server</artifactId>
            <version>${jersey.version}</version>
        </dependency>
        <dependency>
            <groupId>org.glassfish.jersey.containers</groupId>
            <artifactId>jersey-container-servlet</artifactId>
            <version>${jersey.version}</version>
        </dependency>
        <dependency>
            <groupId>org.glassfish.jersey.media</groupId>
            <artifactId>jersey-media-json-jackson</artifactId>
            <version>${jersey.version}</version>
        </dependency>
    </dependencies>
    <build>
        <finalName>jersey</finalName>
    </build>
</project>
  • 定义API接口

定义Restful API接口,在接口类中定义好访问路径、http方式、数据类型、请求参数等

package org.cent.demo.jersey.api;

import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;

/**
 * Created by cent on 2016/9/18.
 */
@Path("/demo")
public interface JerseyDemoApi {

    @Path("hello")
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    public String hello(@QueryParam("name") String name);
}

  • API接口实现类
package org.cent.demo.jersey.api.impl;

import org.cent.demo.jersey.api.JerseyDemoApi;

/**
 * Created by cent on 2016/9/18.
 */
public class JerserDemoApiImpl implements JerseyDemoApi {

    public String hello(String name) {
        return "Hello " + name + "!";
    }
}

  • 自定义ResourceConfig类

这个很关键,必须使用自定义的ResourceConfig类,里面注册API接口的实现类。

package org.cent.demo.jersey.config;

import org.cent.demo.jersey.api.impl.JerserDemoApiImpl;
import org.glassfish.jersey.filter.LoggingFilter;
import org.glassfish.jersey.server.ResourceConfig;

/**
 * Created by cent on 2016/9/18.
 */
public class JerseyResourceConfig extends ResourceConfig {

    public JerseyResourceConfig() {
        //注意:这里注册的是接口实现类!!!
        register(JerserDemoApiImpl.class);

        //注册请求日志Filter,已过时,未找到替换方式
        register(LoggingFilter.class);
    }
}

  • 配置web.xml

配置Jersey servlet时,指定javax.ws.rs.Application参数值为自定义的ResourceConfig类。

<!DOCTYPE web-app PUBLIC
        "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
        "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
    <display-name>Jersey Demo</display-name>

    <servlet>
        <servlet-name>jerseyServlet</servlet-name>
        <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
        <!-- 指定ResourceConfig初始化参数 -->
        <init-param>
            <param-name>javax.ws.rs.Application</param-name>
            <param-value>org.cent.demo.jersey.config.JerseyResourceConfig</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>jerseyServlet</servlet-name>
        <url-pattern>/*</url-pattern>
    </servlet-mapping>
</web-app>

  • 大功告成

Demo项目文件结构如下:

image

  • 运行&测试

部署到Tomcat容器中运行,调用RestfulApi效果如下:

image

  • 示例源码

示例源码地址:https://code.aliyun.com/cent/jersey-demo.git

© 著作权归作者所有

centychen
粉丝 36
博文 23
码字总数 20745
作品 0
广州
高级程序员
私信 提问
加载中

评论(7)

centychen
centychen

引用来自“centychen”的评论

//替换LoggingFilter
//register(LoggingFilter.class);
register(
new LoggingFeature(
Logger.getAnonymousLogger(),
Level.INFO,
LoggingFeature.Verbosity.PAYLOAD_TEXT,
LoggingFeature.DEFAULT_MAX_ENTITY_SIZE
)
);

引用来自“tclemon”的评论

请问怎么把这个用log4j记录啊???
可以参考LoggingFeature的实现重写一个Feature。
t
tclemon

引用来自“centychen”的评论

//替换LoggingFilter
//register(LoggingFilter.class);
register(
new LoggingFeature(
Logger.getAnonymousLogger(),
Level.INFO,
LoggingFeature.Verbosity.PAYLOAD_TEXT,
LoggingFeature.DEFAULT_MAX_ENTITY_SIZE
)
);
请问怎么把这个用log4j记录啊???
yuntui
yuntui
每周精粹
每周精粹
不错
centychen
centychen
//替换LoggingFilter
//register(LoggingFilter.class);
register(
new LoggingFeature(
Logger.getAnonymousLogger(),
Level.INFO,
LoggingFeature.Verbosity.PAYLOAD_TEXT,
LoggingFeature.DEFAULT_MAX_ENTITY_SIZE
)
);
centychen
centychen

引用来自“抓瓦工人”的评论

//注册请求日志Filter,已过时,未找到替换方式
register(LoggingFilter.class);
.
LoggingFeature 替换
83
pantrick
pantrick
//注册请求日志Filter,已过时,未找到替换方式
register(LoggingFilter.class);
.
LoggingFeature 替换
2018年互联网架构主流微服务架构之潮流的主先锋Spring Boot 2.0

一、Spring Boot 介绍 Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定...

A尚学堂Len老师
2018/08/21
0
0
Jersey1.x + Spring 依赖注入出现 空指针异常

在使用rest风格和Spring的依赖注入做一个demo的时候。依赖注入 出现空指针异常 The RuntimeException could not be mapped to a response, re-throwing to the HTTP container java.lang.Nu...

Jeremy_pan
2015/03/13
0
0
规范代码生成器--Swagger-codegen

OpenAPI (f.k.a Swagger) 规范代码生成器,支持 API clients, API servers 和 API documention: API 客户端:ActionScript, Bash, C# (.net 2.0, 4.0 or later), C++ (cpprest, Qt5, Tizen),......

wing328
2017/03/13
1K
1
Acmen-helper一键生成springboot基本项目骨架!

Acmen-helper 还在为繁琐的配置工作和重复的基础Coding而烦恼吗?Acmen-helper一键搞定 。Easy Coding,Enjoy life! 简介 Acmen-helper 是一款代码自动生成工具,通过在web端简单配置数据库连...

Meet相识_bfa5
2018/05/21
0
0
Go 实现的端口转发工具--port-forward

Go语言开发的端口转发工具(for port data forward) 开发语言:GO 控制台框架:beego 功能介绍 支持 Web 控制台添加端口映射 支持对每条端口映射进行开启和关闭控制 支持 RestfulAPI 接口,...

TavenLi
2017/05/31
1K
7

没有更多内容

加载失败,请刷新页面

加载更多

安卓Q | 文件存储沙箱化FAQ,你想知道的这里都有!

文件存储沙箱化作为Android Q最为重要的变更之一,对应用文件存储、访问、分享等操作都带来重大的影响,被众多开发者关注和讨论。本文邀请华为技术专家对开发者提到的重点问题进行了解答,以...

安卓绿色联盟
26分钟前
1
0
可以提高程序员效率的工具!

前言 只有光头才能变强。 文本已收录至我的GitHub仓库,欢迎Star:https://github.com/ZhongFuCheng3y/3y 本文记录一下我在平时喜欢用的一些小工具,以便以后重装系统/换电脑的时候能快速安装...

Java3y
48分钟前
4
0
将博客搬至CSDN

https://blog.csdn.net/qq_38157006

Marhal
54分钟前
1
0
unicode Java中求字符串长度length()和codePointCount()的区别

在计算字符串长度时,Java的两种方法length()和codePointCount()一度让我困惑,运行书上例子得到的长度值是相等的,那为什么要设定两个方法呢? 对于普通字符串,这两种方法得到的值是一样的...

泉天下
55分钟前
2
0
uin-app 一、学习理由

选择uni-app 理由 别人的理由 1. 5+ 有HTML5+和Native.js技术,HTML5+包含常用的跨平台的几百个API,能满足常规开发需求,而Native.js把40w原生api映 射成js对象,这样js可以直接调原生。HTM...

轻轻的往前走
56分钟前
1
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部