Rop开发手册(4):最简单的服务开放平台框架

目录
1.快速了解Rop
2.请求服务模型
3.应用授权及验证
4.服务会话管理
5.错误处理模型
6.响应报文控制
7.文件上传
8.服务安全控制
9.拦截器及事件体系
10.性能调优
11.开发客户端SDK
12.参考资料



会话管理概述

一个客户端应用开发出来后，可以有很多具体的使用者。Rop使用应用键/密钥可以定位到一个具体的客户端应用，但却无法定位到客户端应用当前的使用者。服务开放平台必须开放一个用户登录的服务，在登录成功后分配一个sessionId。这样，应用用户后续对服务平台的服务调用都附上这个sessionId，服务端就可根据这个sessionId判断请求用户的身份了。

Rop作为一个独立的框架，本身不提供具体的用户登录服务，但是它提供了一种管理用户会话的机制，以便管理用户会话并进行用户会话的评论。Rop在com.rop.session包中定义了两个用于会话管理的接口：

• Session：会话对象，该接口没有定义任何的方法，是一个标签接口；
• SessionManager：会话管理器，该接口拥有3个方法，分别是addSession(String sessionId, Session session)、Session getSession(String sessionId)及void removeSession(String sessionId)。

在实际应用中，Session一般会拥有用户相关的数据，如用户信息、用户权限等。由于服务平台一般都是工作于分布式环境中，所以一般不适合直接使用Web服务器的会话管理机制（如HttpSession）来管理Rop的会话，应当使用数据库或集中式缓存服务器等设施来管理会话。

创建会话、删除会话一般对应用户登录、用户退出两个服务，这两个具体的服务由服务开放平台开发，在服务方法中利用SessionManagerRop提供的会话管理功能注册和删除会话，以便让Rop获知会话的状态。
Rop在RopRequestContext中提供了3个管理会话的方法，介绍如下：

• void addSession(String sessionId, Session session)：将会话添加到会话管理器中；
• Session getSession(String sessionId)：根据sessionId获取会话对象；
• void removeSession(String sessionId)：根据sessionId从会话管理器中移除会话。

注册会话管理器

rop-sample提供了一个基于一个Map管理的SampleSessionManager会话管理器，这里我们通过SampleSessionManager演示会话管理器的过程。在实际应用中，您应该使用基于集中式缓存（如memcached）或数据库(redis)等来管理会话。

SampleSessionManager：基于Map的会话管理器

package com.rop.sample;

import com.rop.session.Session;
import com.rop.session.SessionManager;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

public class SampleSessionManager implements SessionManager{

    private final Map<String, Session> sessionCache =         ①  
 new ConcurrentHashMap<String, Session>(128, 0.75f, 32);

    @Override
    public void addSession(String sessionId, Session session) {
        sessionCache.put(sessionId, session);
    }

    @Override
    public Session getSession(String sessionId) {
        return sessionCache.get(sessionId);
    }

    @Override
    public void removeSession(String sessionId) {
        sessionCache.remove(sessionId);
    }
}

开发出会话管理器后，如何将其装配到Rop中呢？答案还是通过<rop:annotation-driven/>的属性：

<rop:annotation-driven session-manager="sampleSessionManager"/>
<bean id="sampleSessionManager" 
      class="com.rop.sample.SampleSessionManager" />

开发登录和退出服务

基于Rop的服务开放平台应当至少包括两个服务，即登录和退出平台的服务。这两个服务方法也应该最先开发出来。下面是rop-sample的登录和退出的服务方法：

UserService.java:登录及退出服务方法

@ServiceMethod(method = "user.logon",version = "1.0",
needInSession = NeedInSessionType.NO) //①
public RopResponse logon(LogonRequest request) {
        
        //②创建会话
	SimpleSession session = new SimpleSession();                          
	session.setAttribute("userName",request.getUserName());
	request.getRopRequestContext().addSession("mockSessionId1", session);

	LogonResponse logonResponse = new LogonResponse();
	logonResponse.setSessionId("mockSessionId1");
	return logonResponse;
}

@ServiceMethod(method = "user.logout",version = "1.0")
public RopResponse logout(RopRequest request) {
	request.getRopRequestContext().removeSession();//③删除会话
	LogoutResponse response = new LogoutResponse();
	response.setSuccessful(true);
	return response;
}

简单来说，登录服务是用于创建会话生成sessionId给客户端的，因此登录服务的方法是工作在非会话环境中的。在默认情况下，所有的服务方法都必须工作于会话环境中，也即每次对服务的请求都必须提供sessionId，否则，Rop就会驳回请求，返回错误的报文。如果希望Rop不对服务方法进行会话校验，需要像①一样，显式将@ServiceMethod的needInSession属性设为NeedInSessionType.NO。

客户端在调用登录服务的方法后，可从响应报文中获取sessionId，这样就可以在后续的服务调带上这个sessionId，Rop会根据sessionId将对应的Session绑定到服务请求上下文RopRequestContext中。