Bu dokümanda, kullanıcının görevlerini Google Tasks API'yi kullanarak görüntüleyecek örnek bir web uygulaması aracılığıyla, Java servlet'leri kullanarak OAuth 2.0 yetkilendirme geri çağırma işleyicisinin nasıl uygulanacağı açıklanmaktadır. Örnek uygulama önce kullanıcının Google Görevlerine erişmek için yetkilendirme ister, ardından varsayılan görevler listesinde kullanıcının görevlerini görüntüler.
Kitle
Bu belge, Java ve J2EE web uygulaması mimarisi konusunda bilgi sahibi kişiler için hazırlanmıştır. OAuth 2.0 yetkilendirme akışı konusunda biraz bilgi sahibi olmanız önerilir.
İçindekiler
Bu şekilde eksiksiz şekilde çalışan bir örneğe sahip olmak için birkaç adım gereklidir:
- web.xml dosyasında servlet eşlemelerini bildirme
- Sisteminizdeki kullanıcıların kimliğini doğrulayın ve Görevler'e erişmek için yetkilendirme isteyin
- Google Yetkilendirme uç noktasından yetkilendirme kodunu dinleme
- Yenileme ve erişim jetonu için yetkilendirme kodunu değiştirme
- Kullanıcının görevlerini okuma ve görüntüleme
web.xml dosyasında servlet eşlemelerini bildir
Uygulamamızda 2 servlet kullanacağız:
- PrintTasksTitlesServlet (/ ile eşlenir): Kullanıcı kimlik doğrulamasını gerçekleştirecek ve kullanıcının görevlerini görüntüleyecek olan uygulama giriş noktası.
- OAuthCodeCallbackHandlerServlet (/oauth2callback ile eşlenir): OAuth yetkilendirme uç noktasından gelen yanıtı işleyen OAuth 2.0 geri çağırması
Aşağıda, bu 2 servlet'i uygulamamızdaki URL'lerle eşleyen web.xml dosyası bulunmaktadır:
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
<servlet>
<servlet-name>PrintTasksTitles</servlet-name>
<servlet-class>com.google.oauthsample.PrintTasksTitlesServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>PrintTasksTitles</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
<servlet>
<servlet-name>OAuthCodeCallbackHandlerServlet</servlet-name>
<servlet-class>com.google.oauthsample.OAuthCodeCallbackHandlerServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>OAuthCodeCallbackHandlerServlet</servlet-name>
<url-pattern>/oauth2callback</url-pattern>
</servlet-mapping>
</web-app>
/WEB-INF/web.xml dosyası
Sisteminizdeki kullanıcıların kimliğini doğrulayın ve sisteminizdeki görevlere erişmek için yetkilendirme isteyin
Kullanıcı, uygulamayı PrintTaskListsTitlesServlet servlet'iyle eşlenen kök "/" URL'si aracılığıyla girer. Bu servlet'te aşağıdaki görevler gerçekleştirilir:
- Sistemde kullanıcının kimliğinin doğrulanıp doğrulanmadığını kontrol eder
- Kullanıcının kimliği doğrulanmazsa kullanıcı, kimlik doğrulama sayfasına yönlendirilir.
- Kullanıcının kimliği doğrulanmışsa veri depolama alanımızda halihazırda bir yenileme jetonunuz olup olmadığını kontrol ederiz. Bu jeton, aşağıdaki OAuthTokenDao tarafından işlenir. Kullanıcı için mağazada yenileme jetonu yoksa bu, kullanıcının henüz görevlerine erişmesi için uygulamaya yetki vermemiş olduğu anlamına gelir. Bu durumda kullanıcı Google'ın OAuth 2.0 Yetkilendirme uç noktasına yönlendirilir.
package com.google.oauthsample;
import ...
/**
* Simple sample Servlet which will display the tasks in the default task list of the user.
*/
@SuppressWarnings("serial")
public class PrintTasksTitlesServlet extends HttpServlet {
/**
* The OAuth Token DAO implementation, used to persist the OAuth refresh token.
* Consider injecting it instead of using a static initialization. Also we are
* using a simple memory implementation as a mock. Change the implementation to
* using your database system.
*/
public static OAuthTokenDao oauthTokenDao = new OAuthTokenDaoMemoryImpl();
public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
// Getting the current user
// This is using App Engine's User Service but you should replace this to
// your own user/login implementation
UserService userService = UserServiceFactory.getUserService();
User user = userService.getCurrentUser();
// If the user is not logged-in it is redirected to the login service, then back to this page
if (user == null) {
resp.sendRedirect(userService.createLoginURL(getFullRequestUrl(req)));
return;
}
// Checking if we already have tokens for this user in store
AccessTokenResponse accessTokenResponse = oauthTokenDao.getKeys(user.getEmail());
// If we don't have tokens for this user
if (accessTokenResponse == null) {
OAuthProperties oauthProperties = new OAuthProperties();
// Redirect to the Google OAuth 2.0 authorization endpoint
resp.sendRedirect(new GoogleAuthorizationRequestUrl(oauthProperties.getClientId(),
OAuthCodeCallbackHandlerServlet.getOAuthCodeCallbackHandlerUrl(req), oauthProperties
.getScopesAsString()).build());
return;
}
}
/**
* Construct the request's URL without the parameter part.
*
* @param req the HttpRequest object
* @return The constructed request's URL
*/
public static String getFullRequestUrl(HttpServletRequest req) {
String scheme = req.getScheme() + "://";
String serverName = req.getServerName();
String serverPort = (req.getServerPort() == 80) ? "" : ":" + req.getServerPort();
String contextPath = req.getContextPath();
String servletPath = req.getServletPath();
String pathInfo = (req.getPathInfo() == null) ? "" : req.getPathInfo();
String queryString = (req.getQueryString() == null) ? "" : "?" + req.getQueryString();
return scheme + serverName + serverPort + contextPath + servletPath + pathInfo + queryString;
}
}
PrintTasksTitlesServlet.java dosyası
Not: Yukarıdaki uygulamada bazı App Engine kitaplıkları kullanılmaktadır. Bu kitaplıklar, kolaylık sağlamak amacıyla kullanılmıştır. Başka bir platform için geliştirme yapıyorsanız kullanıcı kimlik doğrulamasını işleyen UserService arayüzünü yeniden uygulayabilirsiniz.
Uygulama, kullanıcının yetkilendirme jetonlarına erişmeye devam etmek ve bunlara erişmek için bir DAO kullanır. Aşağıda, bu örnekte kullanılan arayüz (OAuthTokenDao) ve örnek (bellek içi) uygulama (OAuthTokenDaoMemoryImpl) verilmiştir:
package com.google.oauthsample;
import com.google.api.client.auth.oauth2.draft10.AccessTokenResponse;
/**
* Allows easy storage and access of authorization tokens.
*/
public interface OAuthTokenDao {
/**
* Stores the given AccessTokenResponse using the {@code username}, the OAuth
* {@code clientID} and the tokens scopes as keys.
*
* @param tokens The AccessTokenResponse to store
* @param userName The userName associated wit the token
*/
public void saveKeys(AccessTokenResponse tokens, String userName);
/**
* Returns the AccessTokenResponse stored for the given username, clientId and
* scopes. Returns {@code null} if there is no AccessTokenResponse for this
* user and scopes.
*
* @param userName The username of which to get the stored AccessTokenResponse
* @return The AccessTokenResponse of the given username
*/
public AccessTokenResponse getKeys(String userName);
}
OAuthTokenDao.java dosyası
package com.google.oauthsample;
import com.google.api.client.auth.oauth2.draft10.AccessTokenResponse;
...
/**
* Quick and Dirty memory implementation of {@link OAuthTokenDao} based on
* HashMaps.
*/
public class OAuthTokenDaoMemoryImpl implements OAuthTokenDao {
/** Object where all the Tokens will be stored */
private static Map tokenPersistance = new HashMap();
public void saveKeys(AccessTokenResponse tokens, String userName) {
tokenPersistance.put(userName, tokens);
}
public AccessTokenResponse getKeys(String userName) {
return tokenPersistance.get(userName);
}
}
OAuthTokenDaoMemoryImpl.java dosyası
Ayrıca uygulamanın OAuth 2.0 kimlik bilgileri bir özellikler dosyasında depolanır. Alternatif olarak, bunları java sınıflarınızın bir yerinde sabit değerler olarak da kullanabilirsiniz. Örnekte kullanılmakta olan OAuthProperties sınıfı ve oauth.properties dosyası:
package com.google.oauthsample;
import ...
/**
* Object representation of an OAuth properties file.
*/
public class OAuthProperties {
public static final String DEFAULT_OAUTH_PROPERTIES_FILE_NAME = "oauth.properties";
/** The OAuth 2.0 Client ID */
private String clientId;
/** The OAuth 2.0 Client Secret */
private String clientSecret;
/** The Google APIs scopes to access */
private String scopes;
/**
* Instantiates a new OauthProperties object reading its values from the
* {@code OAUTH_PROPERTIES_FILE_NAME} properties file.
*
* @throws IOException IF there is an issue reading the {@code propertiesFile}
* @throws OauthPropertiesFormatException If the given {@code propertiesFile}
* is not of the right format (does not contains the keys {@code
* clientId}, {@code clientSecret} and {@code scopes})
*/
public OAuthProperties() throws IOException {
this(OAuthProperties.class.getResourceAsStream(DEFAULT_OAUTH_PROPERTIES_FILE_NAME));
}
/**
* Instantiates a new OauthProperties object reading its values from the given
* properties file.
*
* @param propertiesFile the InputStream to read an OAuth Properties file. The
* file should contain the keys {@code clientId}, {@code
* clientSecret} and {@code scopes}
* @throws IOException IF there is an issue reading the {@code propertiesFile}
* @throws OAuthPropertiesFormatException If the given {@code propertiesFile}
* is not of the right format (does not contains the keys {@code
* clientId}, {@code clientSecret} and {@code scopes})
*/
public OAuthProperties(InputStream propertiesFile) throws IOException {
Properties oauthProperties = new Properties();
oauthProperties.load(propertiesFile);
clientId = oauthProperties.getProperty("clientId");
clientSecret = oauthProperties.getProperty("clientSecret");
scopes = oauthProperties.getProperty("scopes");
if ((clientId == null) || (clientSecret == null) || (scopes == null)) {
throw new OAuthPropertiesFormatException();
}
}
/**
* @return the clientId
*/
public String getClientId() {
return clientId;
}
/**
* @return the clientSecret
*/
public String getClientSecret() {
return clientSecret;
}
/**
* @return the scopes
*/
public String getScopesAsString() {
return scopes;
}
/**
* Thrown when the OAuth properties file was not at the right format, i.e not
* having the right properties names.
*/
@SuppressWarnings("serial")
public class OAuthPropertiesFormatException extends RuntimeException {
}
}
OAuthProperties.java dosyası
Aşağıda, uygulamanızın OAuth 2.0 kimlik bilgilerini içeren oauth.properties dosyası yer alır. Aşağıdaki değerleri kendiniz değiştirmeniz gerekir.
# Client ID and secret. They can be found in the APIs console. clientId=1234567890.apps.googleusercontent.com clientSecret=aBcDeFgHiJkLmNoPqRsTuVwXyZ # API scopes. Space separated. scopes=https://www.googleapis.com/auth/tasks
oauth.properties dosyası
OAuth 2.0 İstemci Kimliği ve İstemci sırrı, uygulamanızı tanımlar ve Görevler API'sinin uygulamanız için tanımlanan filtreler ve kota kuralları uygulamasına olanak tanır. İstemci kimliği ve gizli anahtarı Google API Konsolu'nda bulunabilir. Konsolda yapmanız gerekenler:
- Bir proje oluşturun veya seçin.
- Hizmet listesinde Tasks API durumunu ETKİN olarak ayarlayıp Görevler API'sini etkinleştirin.
- Henüz oluşturulmadıysa API Erişimi altında bir OAuth 2.0 İstemci Kimliği oluşturun.
- Projenin OAuth 2.0 kod geri çağırma işleyici URL'sinin Yönlendirme URI'larında kayıtlı olduğundan/beyaz listeye eklendiğinden emin olun. Örneğin, bu örnek projede, web uygulamanız https://www.example.com alanından sunuluyorsa https://www.example.com/oauth2callback adresini kaydetmeniz gerekir.
API Konsolu'ndaki Yönlendirme URI'si
Google Yetkilendirme uç noktasından yetkilendirme kodunu dinleyin
Kullanıcının henüz görevlerine erişmesi için uygulamayı yetkilendirmediği ve dolayısıyla Google'ın OAuth 2.0 Yetkilendirme uç noktasına yönlendirildiği durumlarda, Google'dan uygulamanıza görevleri için erişim izni vermesini isteyen bir yetkilendirme iletişim kutusu görüntülenir:
Google'ın Yetkilendirme İletişim Kutusu
Erişim izni verildikten veya erişim reddedildikten sonra kullanıcı, Google yetkilendirme URL'si oluşturulurken yönlendirme/geri çağırma olarak belirtilen OAuth 2.0 kod geri çağırma işleyicisine tekrar yönlendirilir:
new GoogleAuthorizationRequestUrl(oauthProperties.getClientId(),
OAuthCodeCallbackHandlerServlet.getOAuthCodeCallbackHandlerUrl(req), oauthProperties
.getScopesAsString()).build()
OAuth 2.0 kod geri çağırma işleyicisi (OAuthCodeCallbackHandlerServlet), Google OAuth 2.0 uç noktasından yönlendirmeyi işler. Ele alınması gereken 2 durum vardır:
- Kullanıcı erişim izni verdi: URL parametrelerinden OAuth 2.0 kodu alma isteğini ayrıştırır.
- Kullanıcı erişimi reddetti: Kullanıcıya bir mesaj gösterir
package com.google.oauthsample;
import ...
/**
* Servlet handling the OAuth callback from the authentication service. We are
* retrieving the OAuth code, then exchanging it for a refresh and an access
* token and saving it.
*/
@SuppressWarnings("serial")
public class OAuthCodeCallbackHandlerServlet extends HttpServlet {
/** The name of the Oauth code URL parameter */
public static final String CODE_URL_PARAM_NAME = "code";
/** The name of the OAuth error URL parameter */
public static final String ERROR_URL_PARAM_NAME = "error";
/** The URL suffix of the servlet */
public static final String URL_MAPPING = "/oauth2callback";
public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
// Getting the "error" URL parameter
String[] error = req.getParameterValues(ERROR_URL_PARAM_NAME);
// Checking if there was an error such as the user denied access
if (error != null && error.length > 0) {
resp.sendError(HttpServletResponse.SC_NOT_ACCEPTABLE, "There was an error: \""+error[0]+"\".");
return;
}
// Getting the "code" URL parameter
String[] code = req.getParameterValues(CODE_URL_PARAM_NAME);
// Checking conditions on the "code" URL parameter
if (code == null || code.length == 0) {
resp.sendError(HttpServletResponse.SC_BAD_REQUEST, "The \"code\" URL parameter is missing");
return;
}
}
/**
* Construct the OAuth code callback handler URL.
*
* @param req the HttpRequest object
* @return The constructed request's URL
*/
public static String getOAuthCodeCallbackHandlerUrl(HttpServletRequest req) {
String scheme = req.getScheme() + "://";
String serverName = req.getServerName();
String serverPort = (req.getServerPort() == 80) ? "" : ":" + req.getServerPort();
String contextPath = req.getContextPath();
String servletPath = URL_MAPPING;
String pathInfo = (req.getPathInfo() == null) ? "" : req.getPathInfo();
return scheme + serverName + serverPort + contextPath + servletPath + pathInfo;
}
}
OAuthCodeCallbackHandlerServlet.java dosyası
Yenileme ve erişim jetonu için yetkilendirme kodunu değiştirin
Ardından OAuthCodeCallbackHandlerServlet, yenileme ve erişim jetonları için Auth 2.0 kodunu değiştirir, bu kodu veri deposunda devam ettirir ve kullanıcıyı tekrar PrintTaskListsTitlesServlet URL'sine yönlendirir:
Aşağıdaki dosyaya eklenen kod söz dizimi vurgulanmıştır, mevcut kod devre dışıdır.
package com.google.oauthsample; import ... /** * Servlet handling the OAuth callback from the authentication service. We are * retrieving the OAuth code, then exchanging it for a refresh and an access * token and saving it. */ @SuppressWarnings("serial") public class OAuthCodeCallbackHandlerServlet extends HttpServlet { /** The name of the Oauth code URL parameter */ public static final String CODE_URL_PARAM_NAME = "code"; /** The name of the OAuth error URL parameter */ public static final String ERROR_URL_PARAM_NAME = "error"; /** The URL suffix of the servlet */ public static final String URL_MAPPING = "/oauth2callback";/** Geri çağırma işlemini gerçekleştirdikten sonra kullanıcının yönlendirileceği URL. Kullanıcıları * yönlendirebileceğiniz birden çok olası URL'niz varsa kullanıcıları Google * yetkilendirme URL'sine yönlendirmeden önce bunu bir çereze kaydetmeyi düşünün. */ genel static final String REDIRECT_URL = "/"; /** OAuth Jetonu DAO uygulaması. Statik başlatma yerine * yerleştirmeyi düşünün. Ayrıca örnek olarak basit bir bellek * uygulamasını kullanıyoruz. Uygulamayı, veritabanı sisteminizi kullanmak olarak değiştirin. */ genel static OAuthTokenService ifadesi.public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException { // Getting the "error" URL parameter String[] error = req.getParameterValues(ERROR_URL_PARAM_NAME); // Checking if there was an error such as the user denied access if (error != null && error.length > 0) { resp.sendError(HttpServletResponse.SC_NOT_ACCEPTABLE, "There was an error: \""+error[0]+"\"."); return; } // Getting the "code" URL parameter String[] code = req.getParameterValues(CODE_URL_PARAM_NAME); // Checking conditions on the "code" URL parameter if (code == null || code.length == 0) { resp.sendError(HttpServletResponse.SC_BAD_REQUEST, "The \"code\" URL parameter is missing"); return; }/** * Construct the OAuth code callback handler URL. * * @param req the HttpRequest object * @return The constructed request's URL */ public static String getOAuthCodeCallbackHandlerUrl(HttpServletRequest req) { String scheme = req.getScheme() + "://"; String serverName = req.getServerName(); String serverPort = (req.getServerPort() == 80) ? "" : ":" + req.getServerPort(); String contextPath = req.getContextPath(); String servletPath = URL_MAPPING; String pathInfo = (req.getPathInfo() == null) ? "" : req.getPathInfo(); return scheme + serverName + serverPort + contextPath + servletPath + pathInfo; }* * @param kodu Yetkilendirme hizmetinden geri alınan kod, https ://getauth-Client-veri Son-Yayin%C5;-Veri-Veri-Geri çağırma (Geri Çağırmanın URL'si) * @param oauthÖzelliklerOAuthCodeCallbackHandlerServlet.java dosyasıNot: Yukarıdaki uygulamada bazı App Engine kitaplıkları kullanılmaktadır. Bu kitaplıklar, kolaylık sağlamak amacıyla kullanılmıştır. Başka bir platform için geliştirme yapıyorsanız kullanıcı kimlik doğrulamasını işleyen UserService arayüzünü yeniden uygulayabilirsiniz.
Kullanıcının görevlerini okuma ve gösterme
Kullanıcı, uygulamaya görevlerine erişim izni verdi. Uygulama, OAuthTokenDao aracılığıyla erişilebilen veri deposuna kaydedilmiş bir yenileme jetonuna sahiptir. PrintTaskListsTitlesServlet servlet, artık kullanıcının görevlerine erişmek ve bunları görüntülemek için bu jetonları kullanabilir:
Aşağıdaki dosyaya eklenen kod söz dizimi vurgulanmıştır, mevcut kod devre dışıdır.
package com.google.oauthsample; import ... /** * Simple sample Servlet which will display the tasks in the default task list of the user. */ @SuppressWarnings("serial") public class PrintTasksTitlesServlet extends HttpServlet { /** * The OAuth Token DAO implementation, used to persist the OAuth refresh token. * Consider injecting it instead of using a static initialization. Also we are * using a simple memory implementation as a mock. Change the implementation to * using your database system. */ public static OAuthTokenDao oauthTokenDao = new OAuthTokenDaoMemoryImpl(); public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException { // Getting the current user // This is using App Engine's User Service but you should replace this to // your own user/login implementation UserService userService = UserServiceFactory.getUserService(); User user = userService.getCurrentUser(); // If the user is not logged-in it is redirected to the login service, then back to this page if (user == null) { resp.sendRedirect(userService.createLoginURL(getFullRequestUrl(req))); return; } // Checking if we already have tokens for this user in store AccessTokenResponse accessTokenResponse = oauthTokenDao.getKeys(user.getEmail()); // If we don't have tokens for this user if (accessTokenResponse == null) { OAuthProperties oauthProperties = new OAuthProperties(); // Redirect to the Google OAuth 2.0 authorization endpoint resp.sendRedirect(new GoogleAuthorizationRequestUrl(oauthProperties.getClientId(), OAuthCodeCallbackHandlerServlet.getOAuthCodeCallbackHandlerUrl(req), oauthProperties .getScopesAsString()).build()); return; }// Yanıtta kullanıcının görev listelerinin başlıklarını yazdırma resp.setContentType("text/plain"); resp.getWriter().append("kullanıcı için görev listeleri başlıkları " + user.getEmail() + ":\n\n"); printTasksTitles(accessTokenResponse, resp.getWriter();} /** * Construct the request's URL without the parameter part. * * @param req the HttpRequest object * @return The constructed request's URL */ public static String getFullRequestUrl(HttpServletRequest req) { String scheme = req.getScheme() + "://"; String serverName = req.getServerName(); String serverPort = (req.getServerPort() == 80) ? "" : ":" + req.getServerPort(); String contextPath = req.getContextPath(); String servletPath = req.getServletPath(); String pathInfo = (req.getPathInfo() == null) ? "" : req.getPathInfo(); String queryString = (req.getQueryString() == null) ? "" : "?" + req.getQueryString(); return scheme + serverName + serverPort + contextPath + servletPath + pathInfo + queryString; }/ Tasks API'de varsayılan görevler listesi almak için kullanılır.** * * * @param accessTokenResponse Erişim jetonunu ve yenileme jetonunu içeren OAuth 2.0 AccessTokenResponse nesnesidir. * @param, görev listesinin başlıklarının işleneceği çıkış akışı yazıcısının çıktısını verir * @return Varsayılan görev listesindeki kullanıcıların görev başlıklarının listesi. * @throws IOException, the initial void screen.exe.jsonservice<PrintTasksTitlesServlet.java dosyasıKullanıcı, görevleriyle birlikte gösterilir:
Kullanıcının görevleriÖrnek uygulama
Bu örnek uygulamanın kodunu buradan indirebilirsiniz. Mutlaka göz atın.