java - 我的 xpage 应用程序的基本 REST 服务

Question

我想为我的 XPage 应用程序设置一些基本的 REST 服务。因此，我在 xpage 上添加了 xe:restService 控件，并在我引用 Java 类的地方选择了 xe:customRestService:

<xe:restService id="restService1" pathInfo="json" state="false">
        <xe:this.service>
            <xe:customRestService contentType="application/json"
                serviceBean="se.banking.desk.CustomSearchHelper">
            </xe:customRestService>
        </xe:this.service>
    </xe:restService>

它自己的 CustomSearchHelper 类仍然很空，但我想知道我是否在正确的轨道上？

这是类的代码:

package se.banking.desk;

import java.io.IOException;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.ibm.domino.services.ServiceException;
import com.ibm.domino.services.rest.RestServiceEngine;
import com.ibm.xsp.extlib.component.rest.CustomService;
import com.ibm.xsp.extlib.component.rest.CustomServiceBean;

public class CustomSearchHelper extends CustomServiceBean {

    @Override
    public void renderService(CustomService service, RestServiceEngine engine) throws ServiceException {

        HttpServletRequest request = engine.getHttpRequest();           
        String method = request.getMethod();

        HttpServletResponse response = engine.getHttpResponse();        
        response.setHeader("Content-Type", "text/javascript; charset=UTF-8");        

        if(method.equals("GET")){
            this.get(engine);
        }
        else if(method.equals("POST")){
            this.post(engine,request);
        }
        else{
            this.other(engine);
        }

    }

    public void get(RestServiceEngine engine){
        HttpServletResponse response = engine.getHttpResponse();
        try {
            response.getWriter().write("get()");
            response.getWriter().close();
            return;
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

    public void post(RestServiceEngine engine,HttpServletRequest request){
      HttpServletResponse response = engine.getHttpResponse();
      Map parameters = request.getParameterMap();
      try {
          response.getWriter().write("post()");
          response.getWriter().write( request.getParameter("form"));
          String[] form = (String[])parameters.get("form");
          String val = form[0];
          response.getWriter().write(val);
        response.getWriter().close();
    } catch (Exception e) {
        // TODO: handle exception
    }     

  }

    public void other(RestServiceEngine engine){
       HttpServletResponse response = engine.getHttpResponse();
        try {
            response.getWriter().write("other()");
            response.getWriter().close();
            return;
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

}

我的问题:这是编写自定义 REST 服务的好方法吗？有其他选择吗？我在哪里可以找到更多从初学者级别开始的示例/信息？

Answer 1

你问了一个相当复杂的问题，过去几年我一直在想这个问题。我的评估是，找到“好方法”取决于应用程序中使用的开发人员和约定。我已经包含了指向我看到的可用替代方案来源的链接，其中一些是我的，其中一些试图从头开始解决一些概念，比如我的 series on http servlets。 .

[更新]我已经编辑了这个答案以包含一些代码示例，因为链接最终无法正常工作的可能性总是存在的；这应该保留答案的意图。[/更新]

您的实现是一个很好的例子，说明了如何将 xe:restService 控件轻松绑定(bind)到 XPage，并在 XPages 运行时和 Domino 服务器中提供了多种可用选项。

据我所知，大约有 5 种独特的方法可以在 XPages 上下文中实现 RESTful API/端点操作。按照易于实现的一般顺序(取决于人):

1. XAgent (这可以与下一个交换；可以在 SSJS 或 Java 中完成的好处是容易上手，有很多可用的示例，并且对那些没有 Java 经验的人来说不那么令人生畏)

<?xml version="1.0" encoding="UTF-8"?>
<xp:view
    xmlns:xp="http://www.ibm.com/xsp/core"
    rendered="false"
    viewState="nostate">
    <xp:this.afterRenderResponse>
        <![CDATA[#{javascript:com.demo.DataProvider.myCustomDataServiceAsJson();}]]>
    </xp:this.afterRenderResponse>

    XAgent. This will not render as a page, but as application/json data.
</xp:view>

1. xe:restService 最好的部分是开箱即用的选项，例如 xe:viewJsonService(Domino 开发人员已经从 View 的角度考虑了和文档，这有点类似于 RESTful API 的集合和记录机制)，正如 Mark 在评论中指出的那样；这些很容易进入，也很方便(很多人在博客上写过这些，Brad has covered some of these rather extensively in his data grids series)
2. xe:restService，如上所示作为 CustomServiceBean 👍 或作为 xe:customRestService 的另一种风格 em>xe:this.doGet等方法(可以通过调用类的方法或SSJS来完成；我推荐前者)

<?xml version="1.0" encoding="UTF-8"?>
<xp:view
    xmlns:xp="http://www.ibm.com/xsp/core"
    xmlns:xe="http://www.ibm.com/xsp/coreex">
    <xe:restService
        id="restService1"
        pathInfo="beers">
        <xe:this.service>
            <xe:customRestService
                contentType="application/json"
                requestContentType="application/json">
                <xe:this.doGet><![CDATA[${javascript:var resp = {
    "data": [
        { "key": "value" }
    ],
    "error": false
};
return toJson(resp);}]]></xe:this.doGet>
            </xe:customRestService>
        </xe:this.service>
    </xe:restService>
</xp:view>

1. 实现a DesignerFacesServlet ，这has some requirements (受益于许多非 Domino/XPages 特定行业惯例，不需要知识/经验/部署 OSGi 插件的能力，将您的应用程序代码包含在 NSF 容器中)； a demo app I wrote follows this implementation ，一个修改后的版本(在该存储库的当前 bluemix 分支中)can be seen running on Bluemix ; the sample here follows Jesse's blog post

public class SampleServlet extends DesignerFacesServlet implements Serializable {
    private static final long serialVersionUID = 1L;

    @SuppressWarnings("unchecked")
    @Override
    public void service(ServletRequest servletRequest, ServletResponse servletResponse) throws ServletException, IOException {
        // Set up handy environment variables
        HttpServletRequest req = (HttpServletRequest)servletRequest;
        HttpServletResponse res = (HttpServletResponse)servletResponse;
        ServletOutputStream out = res.getOutputStream();
        FacesContext facesContext = this.getFacesContext(req, res);

        try {
            res.setContentType("text/plain");

            // write some amazing code!

            out.println("done");

        } catch(Exception e) {
            e.printStackTrace(new PrintStream(out));
        } finally {
            out.close();

            // It shouldn't be null if things are going well, but a check never hurt
            if(facesContext != null) {
                facesContext.responseComplete();
                facesContext.release();
            }
        }
    }
}

1. 创建驱动 HttpServlets 的“真正的”JEE 风格的 OSGi 插件，可以使用 JAX-RS 之类的东西来加快速度(没有像使用 DesignerFacesServlet 那样获取类加载器的麻烦在 NSF 中，只是为了让它与您的 NSF 包含的代码一起玩，但实现 OSGi 插件开发的障碍，which has been covered nicely multiple excellent developers )

至于什么是“好方法”，我觉得各有各的用处，尤其是考虑到开发者的技术水平。对于那些希望在 XPages 应用程序中开始使用此类东西的人，我推荐您正在做的事情，一个带有 CustomServiceBean 扩展类的 xe:restService，或者具有一次性方法的简单类或 bean

[更新]

Shean P. McManus 和我为 ICONUS (fka- IamLug) 为期两天的虚拟 Activity 举办了一场关于“规范化 XPages 开发”的 session 。创建用于 XPage 应用程序的 RESTful API 时可以使用哪些选项的大部分主题都已涵盖。幻灯片均可用 from Shean's blog和 the git project repository on GitHub ;后者包含应用程序代码，以及 a pre-built, stand alone NSF .

[/更新]