在此博客中,我將介紹您需要在應用程序的一兩個頁面上顯示用戶的Facebook或其他軟件即服務(SaaS)提供程序數據的情況。 這里的想法是試圖演示最小的和最簡單的操作,您可以將Spring Social添加到需要用戶登錄Facebook或其他SaaS提供商的應用程序中。
創建應用
要創建該應用程序,第一步是使用SpringSource Toolkit儀表板的模板部分創建一個基本的Spring MVC項目。 這提供了一個Web應用程序,可幫助您入門。
下一步是通過添加以下依賴項來設置pom.xml :
<dependency><groupId>org.springframework.security</groupId><artifactId>spring-security-crypto</artifactId><version>${org.springframework.security.crypto-version}</version>
</dependency><!-- Spring Social -->
<dependency><groupId>org.springframework.social</groupId><artifactId>spring-social-core</artifactId><version>${spring-social.version}</version>
</dependency>
<dependency><groupId>org.springframework.social</groupId><artifactId>spring-social-web</artifactId><version>${spring-social.version}</version>
</dependency><!-- Facebook API -->
<dependency><groupId>org.springframework.social</groupId><artifactId>spring-social-facebook</artifactId><version>${org.springframework.social-facebook-version}</version>
</dependency><!-- JdbcUserConfiguration -->
<dependency><groupId>org.springframework</groupId><artifactId>spring-jdbc</artifactId><version>${org.springframework-version}</version>
</dependency>
<dependency><groupId>com.h2database</groupId><artifactId>h2</artifactId><version>1.3.159</version>
</dependency><!-- CGLIB, only required and used for @Configuration usage: could be removed in future release of Spring -->
<dependency><groupId>cglib</groupId><artifactId>cglib-nodep</artifactId><version>2.2</version>
</dependency>
…顯然,您還需要在文件的%lt; properties />部分中添加以下內容:
<spring-social.version>1.0.2.RELEASE</spring-social.version>
<org.springframework.social-facebook-version>1.0.1.RELEASE</org.springframework.social-facebook-version>
<org.springframework.security.crypto-version>3.1.0.RELEASE</org.springframework.security.crypto-version>
您會注意到,我為spring-security-crypto添加了一個特定的pom條目:這是因為我正在使用Spring 3.0.6。 在Spring 3.1.x中,它已成為核心庫的一部分。
唯一要注意的一點是,還依賴于spring-jdbc和h2 。 這是因為Spring的UserConnectionRepository默認實現: JdbcUsersConnectionRepository使用它們,因此即使該應用程序不對數據庫持久化任何東西,它們也是必需的(據我所知)。
班級
社交編碼功能包括四個類(其中一個是我從Keith Donald的Spring Social Quick Start Sample代碼中摘錄的):
- FacebookPostsController
- 社會背景
- Facebook配置
- UserCookieGenerator
FacebookPostsController是應用程序的業務端,負責獲取用戶的Facebook數據并將其推入模型中以供顯示。
@Controllerpublic class FacebookPostsController {private static final Logger logger = LoggerFactory.getLogger(FacebookPostsController.class);private final SocialContext socialContext;@Autowiredpublic FacebookPostsController(SocialContext socialContext) {this.socialContext = socialContext;}@RequestMapping(value = 'posts', method = RequestMethod.GET)public String showPostsForUser(HttpServletRequest request, HttpServletResponse response, Model model) throws Exception {String nextView;if (socialContext.isSignedIn(request, response)) {List<Post> posts = retrievePosts();model.addAttribute('posts', posts);nextView = 'show-posts';} else {nextView = 'signin';}return nextView;}private List<Post> retrievePosts() {Facebook facebook = socialContext.getFacebook();FeedOperations feedOps = facebook.feedOperations();List<Post> posts = feedOps.getHomeFeed();logger.info('Retrieved ' + posts.size() + ' posts from the Facebook authenticated user');return posts;}}
如您所見,從高級角度來看,我們要實現的目標的邏輯非常簡單:
IF user is signed in THEN read Facebook data, display Facebook data
ELSE ask user to sign in when user has signed in, go back to the beginning
END IF
FacebookPostsController將處理登錄邏輯的任務委派給SocialContext類。 您可能會猜到,我從Spring真正有用的ApplicationContext中得到了此類的想法。 這里的想法是,有一個類負責將您的應用程序粘貼到Spring Social。
public class SocialContext implements ConnectionSignUp, SignInAdapter {/*** Use a random number generator to generate IDs to avoid cookie clashes* between server restarts*/private static Random rand;/*** Manage cookies - Use cookies to remember state between calls to the* server(s)*/private final UserCookieGenerator userCookieGenerator;/** Store the user id between calls to the server */private static final ThreadLocal<String> currentUser = new ThreadLocal<String>();private final UsersConnectionRepository connectionRepository;private final Facebook facebook;public SocialContext(UsersConnectionRepository connectionRepository, UserCookieGenerator userCookieGenerator,Facebook facebook) {this.connectionRepository = connectionRepository;this.userCookieGenerator = userCookieGenerator;this.facebook = facebook;rand = new Random(Calendar.getInstance().getTimeInMillis());}@Overridepublic String signIn(String userId, Connection<?> connection, NativeWebRequest request) {userCookieGenerator.addCookie(userId, request.getNativeResponse(HttpServletResponse.class));return null;}@Overridepublic String execute(Connection<?> connection) {return Long.toString(rand.nextLong());}public boolean isSignedIn(HttpServletRequest request, HttpServletResponse response) {boolean retVal = false;String userId = userCookieGenerator.readCookieValue(request);if (isValidId(userId)) {if (isConnectedFacebookUser(userId)) {retVal = true;} else {userCookieGenerator.removeCookie(response);}}currentUser.set(userId);return retVal;}private boolean isValidId(String id) {return isNotNull(id) && (id.length() > 0);}private boolean isNotNull(Object obj) {return obj != null;}private boolean isConnectedFacebookUser(String userId) {ConnectionRepository connectionRepo = connectionRepository.createConnectionRepository(userId);Connection<Facebook> facebookConnection = connectionRepo.findPrimaryConnection(Facebook.class);return facebookConnection != null;}public String getUserId() {return currentUser.get();}public Facebook getFacebook() {return facebook;}}
SocialContext實現Spring Social的ConnectionSignUp和SignInAdapter接口。 它包含三個方法isSignedIn() , signIn() , execute() 。 FacebookSignsController類調用isSignedIn來實現上述邏輯,而Spring Social調用signIn()和execute() 。
從我以前的博客中,您會記住,OAuth需要在瀏覽器,您的應用程序和SaaS提供程序之間進行多次旅行。 在進行這些操作時,應用程序需要保存多個OAuth參數的狀態,例如:client_id,redirect_uri和其他參數。 通過將OAuth對話的狀態映射到您的Webapp所控制的變量,Spring Social將所有這些復雜性從應用程序中隱藏起來。 這是userId ; 但是,不要以為它是用戶名,因為用戶從未看到過它,它只是一個唯一標識符,該標識符將許多HTTP請求鏈接到Spring Social核心中的SaaS提供程序連接(例如Facebook)。
由于其簡單性,我遵循了Keith Donald的想法,即使用cookie在瀏覽器和服務器之間傳遞用戶ID來保持狀態。 我還從Spring Social Quick Start中借用了他的UserCookieGenerator類來幫助我。
isSignedIn(...)方法使用UserCookieGenerator來確定HttpServletRequest對象是否包含包含有效用戶ID的cookie。 如果這樣做的話,它還會找出Spring Social的UsersConnectionRepository是否包含鏈接到相同用戶ID的ConnectionRepository 。 如果這兩個測試都返回true,則應用程序將請求并顯示用戶的Facebook數據。 如果兩個測試之一返回false,則將要求用戶登錄。
SocialContext是專門為該示例編寫的,并且包含足夠的功能來演示我在此博客中所討論的內容。 這意味著它目前有點粗糙并且可以使用,盡管可以對其進行改進以涵蓋與任何/許多提供程序的連接,然后在不同的應用程序中重復使用。
最后要提到的類是FacebookConfig ,它大致基于Spring Social示例代碼。 此代碼與示例代碼之間有兩個主要區別,其中第一點是FacebookConfig類實現了InitializingBean接口。 這樣,可以將usersConnectionRepositiory變量注入到socialContext中, 然后可以將socialContext作為其ConnectionSignUp實現注入到usersConnectionRepositiory中。 第二個區別是我正在實現providerSignInController(...)方法,以提供正確配置的ProviderSignInController對象,Spring Social將使用該對象登錄Facebook。 我在此處所做的默認更改的唯一更改是將ProviderSignInController的postSignInUrl屬性設置為“ / posts ”。 這是頁面的URL,將包含用戶Facebook數據,并在用戶登錄完成后被調用。
@Configurationpublic class FacebookConfig implements InitializingBean {private static final Logger logger = LoggerFactory.getLogger(FacebookConfig.class);private static final String appId = '439291719425239';private static final String appSecret = '65646c3846ab46f0b44d73bb26087f06';private SocialContext socialContext;private UsersConnectionRepository usersConnectionRepositiory;@Injectprivate DataSource dataSource;/*** Point to note: the name of the bean is either the name of the method* 'socialContext' or can be set by an attribute* * @Bean(name='myBean')*/@Beanpublic SocialContext socialContext() {return socialContext;}@Beanpublic ConnectionFactoryLocator connectionFactoryLocator() {logger.info('getting connectionFactoryLocator');ConnectionFactoryRegistry registry = new ConnectionFactoryRegistry();registry.addConnectionFactory(new FacebookConnectionFactory(appId, appSecret));return registry;}/*** Singleton data access object providing access to connections across all* users.*/@Beanpublic UsersConnectionRepository usersConnectionRepository() {return usersConnectionRepositiory;}/*** Request-scoped data access object providing access to the current user's* connections.*/@Bean@Scope(value = 'request', proxyMode = ScopedProxyMode.INTERFACES)public ConnectionRepository connectionRepository() {String userId = socialContext.getUserId();logger.info('Createung ConnectionRepository for user: ' + userId);return usersConnectionRepository().createConnectionRepository(userId);}/*** A proxy to a request-scoped object representing the current user's* primary Facebook account.* * @throws NotConnectedException* if the user is not connected to facebook.*/@Bean@Scope(value = 'request', proxyMode = ScopedProxyMode.INTERFACES)public Facebook facebook() {return connectionRepository().getPrimaryConnection(Facebook.class).getApi();}/*** Create the ProviderSignInController that handles the OAuth2 stuff and* tell it to redirect back to /posts once sign in has completed*/@Beanpublic ProviderSignInController providerSignInController() {ProviderSignInController providerSigninController = new ProviderSignInController(connectionFactoryLocator(),usersConnectionRepository(), socialContext);providerSigninController.setPostSignInUrl('/posts');return providerSigninController;}@Overridepublic void afterPropertiesSet() throws Exception {JdbcUsersConnectionRepository usersConnectionRepositiory = new JdbcUsersConnectionRepository(dataSource,connectionFactoryLocator(), Encryptors.noOpText());socialContext = new SocialContext(usersConnectionRepositiory, new UserCookieGenerator(), facebook());usersConnectionRepositiory.setConnectionSignUp(socialContext);this.usersConnectionRepositiory = usersConnectionRepositiory;}}
申請流程
如果您運行此應用程序2,首先會看到一個主屏幕,其中包含一個簡單的鏈接,邀請您顯示帖子。 首次單擊此鏈接時,您將重定向到/ signin頁面。 按下“登錄”按鈕,指示ProviderSignInController與Facebook聯系。 身份驗證完成后, ProviderSignInController會將應用程序定向回/ posts頁面,這一次它將顯示Facebook數據。
組態
為了完整起見,我認為我應該提到XML配置,盡管它沒有太多,因為我在FacebookConfig類上使用Spring注釋@Configuration 。 我已經從Spring Social導入了“ data.xml ”,以便JdbcUsersConnectionRepository可以工作并添加了
<context:component-scan base-package='com.captaindebug.social' />
…用于自動接線。
摘要
盡管此示例應用程序基于將應用程序連接到用戶的Facebook數據的基礎,但可以輕松地對其進行修改以使用任何Spring Social客戶端模塊。 如果您喜歡挑戰,請嘗試使用所有中文版本的Sina-Weibo,這是一個挑戰,但是Google Translate確實很有用。
1個Spring社交和其他OAuth博客:
- Spring Social入門
- Facebook和Twitter:幕后花絮
- OAuth管理步驟
- OAuth 2.0 Webapp流程概述
2該代碼可在Github上找到:https://github.com/roghughe/captaindebug.git
參考: Captain Debug的Blog博客中的JCG合作伙伴 Roger Hughes的Spring Social入門-第2部分 。
翻譯自: https://www.javacodegeeks.com/2012/07/getting-started-with-spring-social-part.html