1. 程式人生 > >內嵌jetty 通過resteasy 實現restful介面

內嵌jetty 通過resteasy 實現restful介面

專案中有時會需要將一些功能暴露為webservice介面供其他應用呼叫,restful作為輕量級webservice是為不錯的選擇,使用resteasy我們需要很少的程式碼編寫即可實現。

廢話少說,上程式碼

示例model 

public class User {
    private String id;
    private String name;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

webservice介面
import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import java.util.List;

@Path("/user")
public interface UserService {
    String MEDIA_TYPE_JSON_UTF8 = MediaType.APPLICATION_JSON + ";charset=UTF-8";
    @GET
    @Path("/{id}")
    @Produces(MEDIA_TYPE_JSON_UTF8)
    User get(@PathParam("id") String id);

    @GET
    @Path("/all")
    @Produces(MEDIA_TYPE_JSON_UTF8)
    List<User> all();

    @POST
    @Path("/add")
    @Produces(MEDIA_TYPE_JSON_UTF8)
    @Consumes(MEDIA_TYPE_JSON_UTF8)
    User add(User user);

    @DELETE
    @Path("/{id}")
    @Produces(MEDIA_TYPE_JSON_UTF8)
    void delete(@PathParam("id") String id);
}

webservice介面實現(省略Dao實現)

import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import javax.annotation.Resource;
import java.util.List;

@Service("DefaultUserService")
@Transactional
public class DefaultUserService implements UserService {

    @Resource
    private UserDao userDao;

    @Override
    public User get(String id) {
        return userDao.get(id);
    }

    @Override
    public List<User> all() {
        return userDao.queryAll();
    }

    @Override
    public User add(User user) {
        return userDao.save(user);
    }

    @Override
    public void delete(String id) {
        userDao.delete(id);
    }
}
rest服務端(jetty內嵌實現)
import org.eclipse.jetty.server.Connector;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.server.ServerConnector;
import org.eclipse.jetty.servlet.ServletContextHandler;
import org.eclipse.jetty.servlet.ServletHolder;
import org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher;
import org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap;
import org.jboss.resteasy.plugins.spring.SpringContextLoaderListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.ArrayList;
import java.util.List;

@Component("restServer")
public class RestServer {

    private Logger logger = LoggerFactory.getLogger(getClass());
    private Server restServer;
    private String hostIp = "127.0.0.1";
    private int port = 8097;

    @PostConstruct
    public void init(){
        restServer = new Server();
        final List<Connector> connectors = new ArrayList<>();
        ServerConnector connectorV4 = new ServerConnector(restServer);
        connectorV4.setHost(hostIp);
        connectorV4.setPort(port);
        connectors.add(connectorV4);
        logger.info("IPV4 Connector Info:HostIP:"+this.hostIp+", Port:"+this.port);

        restServer.setConnectors(connectors.toArray(new Connector[connectors.size()]));
        ServletContextHandler contextHandler = new ServletContextHandler();
        contextHandler.setContextPath("/");//設定上下文

        contextHandler.addEventListener(new ResteasyBootstrap());
        contextHandler.addEventListener(new SpringContextLoaderListener());//instead of ContextLoaderListener
        contextHandler.setInitParameter("contextConfigLocation", "classpath:spring.xml");

        ServletHolder holder = new ServletHolder(HttpServletDispatcher.class);
        holder.setInitParameter("resteasy.servlet.mapping.prefix", "/");//resteasy字首
        holder.setInitOrder(1);
        holder.setAsyncSupported(true);
        contextHandler.addServlet(holder,"/*");//servlet過濾規則
        restServer.setHandler(contextHandler);
        try {
            restServer.start();
        } catch (Exception e) {
            logger.error("rest server start failed!");
            logger.error(e.getMessage(), e);
        }
    }

    @PreDestroy
    public void destroy() {
        if(restServer != null){
            try {
                restServer.stop();
            } catch (Exception e) {
                logger.error(e.getMessage(), e);
            }
        }
    }

    public void setHostIp(String hostIp) {
        this.hostIp = hostIp;
    }

    public void setPort(int port) {
        this.port = port;
    }

    public static void main(String[] args) {
        RestServer resourcePackageRest = new RestServer();
        resourcePackageRest.init();
        System.out.println("rest server started successful!");
    }
}
maven 依賴
<dependency>
            <groupId>org.jboss.resteasy</groupId>
            <artifactId>jaxrs-api</artifactId>
            <version>3.0.11.Final</version>
        </dependency>
        <dependency>
            <groupId>org.jboss.resteasy</groupId>
            <artifactId>resteasy-jaxrs</artifactId>
            <version>3.0.11.Final</version>
        </dependency>
        <dependency>
            <groupId>org.jboss.resteasy</groupId>
            <artifactId>resteasy-jackson2-provider</artifactId>
            <version>3.0.11.Final</version>
        </dependency>
        <dependency>
            <groupId>org.jboss.resteasy</groupId>
            <artifactId>resteasy-servlet-initializer</artifactId>
            <version>3.0.11.Final</version>
        </dependency>
        <dependency>
            <groupId>org.jboss.resteasy</groupId>
            <artifactId>resteasy-spring</artifactId>
            <version>3.0.11.Final</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>4.1.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>4.1.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>4.1.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.eclipse.jetty</groupId>
            <artifactId>jetty-server</artifactId>
            <version>9.4.6.v20170531</version>
        </dependency>
        <dependency>
            <groupId>org.eclipse.jetty</groupId>
            <artifactId>jetty-servlet</artifactId>
            <version>9.4.6.v20170531</version>
        </dependency>

此時,restful服務端已成功部署,瀏覽器可訪問測試,resteasy會根據註解自動部署為webservice

restful客戶端程式碼,非常簡單的程式碼,通過ResteasyClient的target方法,會生成ResteasyWebTarget物件,通過他的proxy可直接生成對應api介面的rest客戶端

import user.apis.UserService;
import org.jboss.resteasy.client.jaxrs.ResteasyClient;
import org.jboss.resteasy.client.jaxrs.ResteasyClientBuilder;
import org.jboss.resteasy.client.jaxrs.ResteasyWebTarget;

public class RestResourcePackageClient{

    private ResteasyWebTarget baseTarget;
    private String baseUri;

    public void init(){
        if(baseUri == null || baseUri.length()==0){
            throw new NullPointerException("base uri is null!");
        }
        ResteasyClient client = new ResteasyClientBuilder().build();
        baseTarget = client.target(baseUri);
    }

    public UserService userService() {
        return baseTarget.proxy(UserService.class);
    }

        public void setBaseUri(String baseUri) {
        this.baseUri = baseUri;
    }
}
客戶端pom依賴
<dependency>
            <groupId>user.respack</groupId>
            <artifactId>respack-api</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.jboss.resteasy</groupId>
            <artifactId>resteasy-client</artifactId>
            <version>3.0.11.Final</version>
        </dependency>
        <dependency>
            <groupId>org.jboss.resteasy</groupId>
            <artifactId>resteasy-jackson2-provider</artifactId>
            <version>3.0.11.Final</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.9.0.pr4</version>
        </dependency>
測試client
public class LocalTest {
    public static void main(String[] args) throws BusinessException {
        RestResourcePackageClient restResourcePackageClient = new RestResourcePackageClient();
        restResourcePackageClient.setBaseUri("http://127.0.0.1:8097/");
        restResourcePackageClient.init();
        UserService userService = restResourcePackageClient.userService();
        userService.all().forEach((user -> System.out.println("id:"+user.getId()+",name:"+user.getName())));
    }
}