JOAuth,一个基于java的OAuth 1(最终)和OAuth 2(草案10)库。我该如何使用它?

时间:2010-12-07 12:32:15

标签: java oauth joauth

我在这里看到太多问题(SO)询问OAuth以及如何使用OAuth协议连接到Facebook Graph API或Twitter API。

我发现JOAuth(来自Google代码),我想知道如何使用它? JOAuth提供了哪些其他功能,并且与其他java oauth库相比是否很好?

1 个答案:

答案 0 :(得分:13)

看到我写过JOAuth,我认为在SO上回答这个问题是合适的。我没有找到将此问题作为社区维基的选项。 :(

注意我不是来讨论OAuth Authorization。有各种各样的网站专门为此。

JOAuth带来了一个很棒的功能。它有一个控制器OAuthServlet,用于管理来自服务提供商的HTTP重定向响应。 将OAuthServlet配置到您的网络应用程序的方法,只需在<servlet>中将其声明为web.xml,就像这样:

 <servlet>
  <description>An OAuth Servlet Controller</description>
  <display-name>OAuthServlet</display-name>
  <servlet-name>OAuthServlet</servlet-name>
  <servlet-class>com.neurologic.oauth.servlet.OAuthServlet</servlet-class>
  <init-param>
   <param-name>config</param-name>
   <param-value>/WEB-INF/oauth-config.xml</param-value>
  </init-param>
  <load-on-startup>3</load-on-startup>
 </servlet>

你的servlet映射:

 <servlet-mapping>
  <servlet-name>OAuthServlet</servlet-name>
  <url-pattern>/oauth/*</url-pattern>
 </servlet-mapping>

现在,你有一个OAuth servlet设置(请记住,<load-on-startup>不是必需的,但我喜欢在我使用它之前初始化我的servlet),让我们谈谈配置JOAuth。

默认的JOAuth配置文件是/WEB-INF/oauth-config.xml(因此它不必是您的servlet声明中的<init-param>)。 配置文件如下所示:

<?xml version="1.0" encoding="UTF-8"?>
<oauth-config>
 <!-- Twitter OAuth Config -->
 <oauth name="twitter" version="1">
  <consumer key="TWITTER_KEY" secret="TWITTER_SECRET" />
  <provider requestTokenUrl="https://api.twitter.com/oauth/request_token" authorizationUrl="https://api.twitter.com/oauth/authorize" accessTokenUrl="https://api.twitter.com/oauth/access_token" />
 </oauth>

 <!-- Facebook OAuth -->
 <oauth name="facebook" version="2">
  <consumer key="APP_ID" secret="APP_SECRET" />
  <provider authorizationUrl="https://graph.facebook.com/oauth/authorize" accessTokenUrl="https://graph.facebook.com/oauth/access_token" />
 </oauth>

 <service path="/request_token_ready" class="com.neurologic.music4point0.oauth.TwitterOAuthService" oauth="twitter">
  <success path="/start.htm" />
 </service>

 <service path="/oauth_redirect" class="com.neurologic.music4point0.oauth.FacebookOAuthService" oauth="facebook">
  <success path="/start.htm" />
 </service>
</oauth-config>

您会注意到每个<oauth>元素都有一个version属性(这是控制器需要知道要使用哪个oauth流的强制属性)。这些有2个可能的值(OAuth1为1,OAuth 2为2。 对于OAuth 2,<consumer>元素没有像版本1对应的requestTokenUrl属性。

OAuth服务负责OAuth处理。控制器通过OAuthService方法调用每个execute()OAuthService有两种类型:

  • com.neurologic.oauth.service.impl.OAuth1Service
  • com.neurologic.oauth.service.impl.OAuth2Service

注意对于每项服务,如果您使用的是OAuth 2,则必须拥有扩展 OAuth2Service的服务。这同样适用于OAuth 1.如果不这样做会导致抛出异常。

每个<service>代码必须具有name属性匹配 <oauth> name属性(区分大小写) )。

最好处理OAuth授权协议的流程已经实现了OAuth1ServiceOAuth2Service execute(HttpServletRequest, HttpServletResponse),但是如果你是不满意。

com.neurologic.music4point0.oauth.FacebookOAuthService的一个例子:

import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import net.oauth.enums.GrantType;
import net.oauth.exception.OAuthException;
import net.oauth.parameters.OAuth2Parameters;

import com.neurologic.oauth.service.impl.OAuth2Service;
import com.neurologic.oauth.util.Globals;

/**
 * @author The Elite Gentleman
 * @since 05 December 2010
 *
 */
public class FacebookOAuthService extends OAuth2Service {

 private static final String REDIRECT_URL = "http://localhost:8080/Music4Point0/oauth/oauth_redirect";

 /* (non-Javadoc)
  * @see com.neurologic.oauth.service.impl.OAuth2Service#processReceivedAuthorization(javax.servlet.http.HttpServletRequest, java.lang.String, java.util.Map)
  */
 @Override
 protected String processReceivedAuthorization(HttpServletRequest request, String code, Map<String, String> additionalParameters) throws OAuthException {
  // TODO Auto-generated method stub
  OAuth2Parameters parameters = new OAuth2Parameters();
  parameters.setCode(code);
  parameters.setRedirectUri(REDIRECT_URL);

  Map<String, String> responseMap = getConsumer().requestAcessToken(GrantType.AUTHORIZATION_CODE, parameters, null, (String[])null);
  if (responseMap == null) {
   //This usually should never been thrown, but we just do anyway....
   throw new OAuthException("No OAuth response retrieved.");
  }

  if (responseMap.containsKey("error")) {
   throwOAuthErrorException(responseMap);
  }

  if (responseMap.containsKey(OAuth2Parameters.ACCESS_TOKEN)) {
   String accessToken = responseMap.remove(OAuth2Parameters.ACCESS_TOKEN);
   request.getSession().setAttribute(Globals.SESSION_OAUTH2_ACCESS_TOKEN, accessToken);
   processAdditionalReceivedAccessTokenParameters(request, responseMap);
  }

  return null;
 }

 /* (non-Javadoc)
  * @see com.neurologic.oauth.service.impl.OAuth2Service#processAdditionalReceivedAccessTokenParameters(javax.servlet.http.HttpServletRequest, java.util.Map)
  */
 @Override
 protected void processAdditionalReceivedAccessTokenParameters(HttpServletRequest request, Map<String, String> additionalParameters) throws OAuthException {
  // TODO Auto-generated method stub

 }
}

由于Facebook仍然使用OAuth 2草案0(零),因此他们的访问令牌不会执行HTTP 302重定向,这就是processReceivedAuthorization()返回null的原因。 processReceivedAuthorization()方法允许客户端处理收到的自动化code期望授权URL(这就是为什么它需要返回类型String)。 如果方法返回null或空字符串,则永远不会发生URL重定向。

完成oauth流程后,将调用<success>元素中的路径(通过RequestDispatcher),以显示OAuth已成功完成。

要访问访问令牌(在通过OAuth成功登录后),请执行以下操作:

AccessToken accessToken = (AccessToken)request.getSession().getAttribute(Globals.SESSION_OAUTH1_ACCESS_TOKEN); //For OAuth 1 access token
String accessToken = (String)request.getSession().getAttribute(Globals.SESSION_OAUTH2_ACCESS_TOKEN); //For OAuth 2 access token.

我希望这个小例子可以帮助那些热衷于为OAuth开发的人提供有价值的体验。

很抱歉,我找不到community wiki复选框。如果你有时间,请访问我的博客(几乎没有任何内容)。

Adieu :-)

PS 这是TwitterOAuthService

的实现
import javax.servlet.http.HttpServletRequest;

import net.oauth.exception.OAuthException;
import net.oauth.signature.impl.OAuthHmacSha1Signature;
import net.oauth.token.AccessToken;
import net.oauth.token.AuthorizedToken;
import net.oauth.token.RequestToken;

import com.neurologic.oauth.service.impl.OAuth1Service;

/**
 * @author The Elite Gentleman
 * @since 05 December 2010
 *
 */
public class TwitterOAuthService extends OAuth1Service {

    public static final String REQUEST_TOKEN_SESSION = "TWITTER_REQUEST_TOKEN_SESSION";

    /* (non-Javadoc)
     * @see com.neurologic.oauth.service.impl.OAuth1Service#processReceivedAuthorizedToken(javax.servlet.http.HttpServletRequest, net.oauth.token.AuthorizedToken)
     */
    @Override
    protected AccessToken processReceivedAuthorizedToken(HttpServletRequest request, AuthorizedToken authorizedToken) throws OAuthException {
        // TODO Auto-generated method stub
        String requestTokenSecret = null;
        RequestToken requestToken = (RequestToken) request.getSession().getAttribute(REQUEST_TOKEN_SESSION);

        if (requestToken != null) {
            requestTokenSecret = requestToken.getTokenSecret();
        }

        return getConsumer().requestAccessToken(null, authorizedToken, requestTokenSecret, new OAuthHmacSha1Signature());
    }
}

其他资源