如何利用AngularJS服务接入外部API

译文
开发 前端
除了轻松对HTML进行扩展的能力之外,AngularJS还提供一套简便途径、帮助我们与外部API实现交互。在今天的教程中,我们将共同探讨如何利用其服务与GitHub的API相对接,进而创建一套简单的库浏览器。

如何利用AngularJS服务接入外部API

除了轻松对HTML进行扩展的能力之外,AngularJS还提供一套简便途径、帮助我们与外部API实现交互。在今天的教程中,我们将共同探讨如何利用其服务与GitHub的API相对接,进而创建一套简单的库浏览器。

***步:准备工作

我们就以下面这套基础HTML模板为起点:

  1. <!DOCTYPE html> 
  2. <html> 
  3.     <head> 
  4.         <title>GitHub Search</title> 
  5.     </head> 
  6.     <body> 
  7.    
  8.     </body> 
  9. </html> 

现在将AngularJS脚本添加到该文档的<head>当中:

  1. <script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.2.16/angular.min.js"></script> 

在此之后,我们可以在将这套CCS样式添加到行内或者独立的文件当中:

 

  1. * {  
  2.     -webkit-box-sizing: border-box;  
  3.     -moz-box-sizing: border-box;  
  4.     box-sizing: border-box;  
  5.     font-familysans-serif;  
  6. }  
  7.    
  8. body, html { margin0; }  
  9. p { margin0; }  
  10. input { width100%; }  
  11.    
  12. pre {  
  13.     white-space: pre-wrap;  
  14.     white-space: -moz-pre-wrap;  
  15.     white-space: -pre-wrap;  
  16.     white-space: -o-pre-wrap;  
  17.     word-wrap: break-word;  
  18. }  
  19.    
  20. div.repo {  
  21.     border-bottom1px solid;  
  22.     cursorpointer;  
  23. }  
  24.    
  25. #search#repo#user { floatleft; }  
  26. #search { width20%; }  
  27. #repo { width60%; }  
  28. #user { width20%; } 

 

如大家所见,其中不存在任何多余的内容、只保留最基础的布局方案——将搜索栏置于右侧、库信息位于中央、用户库同样置于右侧。我们还需要将对应代码行打包至<pre>标签当中,此后我们还要利用它显示README文件内容——因为这些内容通常来自GitHub Flavored Markdown、而且其中一部分代码行与用户库列表存在重叠。

当然,大家可以向其中添加更多样式以提升成果的视觉效果——但请注意,本教程中的截图都采取最基本的外观设计。

大家可以未来需要编写的JavaScript代码置于本文档的<head>当中或者为其建立独立文件,但独立文件仍然需要处于AngularJS脚本之下。

第二步:模块

现在我们可以为自己的应用程序创建一个模块:

  1. var app = angular.module('githubsearch', []); 

接下来利用ngApp指令将其添加到<body>标签当中:

  1. <body ng-app="githubsearch"> 

第三步:控制器

我们还需要为自己的应用程序准备一套控制器。为了简化创建流程,我们将只为应用准备一套控制器,这样我们就不必考虑如何在不同控制器之间进行信息传递了:

 

  1. app.controller('SearchController'function SearchController($scope) {  
  2.        
  3. }); 

 

第四步:基础服务

我们需要对自己的GitHub服务进行定义:

 

  1. app.factory('GitHub'function GitHub($http) {  
  2.     return {  
  3.    
  4.     };  
  5. });  

 

我们将使用app.factory()方法,这样就能保证返回对象附带几个以后将会用到的方法。我们将使用$http服务从GitHub的API中获取数据。

第五步:搜索库

我们服务中的***项方法负责利用GitHub API对库进行搜索。使用服务非常简单(这项函数能够进入由制造函数返回的对象):

 

  1. searchRepos: function searchRepos(query, callback) {  
  2.     $http.get('https://api.github.com/search/repositories', { params: { q: query } })  
  3.         .success(function (data) {  
  4.             callback(null, data);  
  5.         })  
  6.         .error(function (e) {  
  7.             callback(e);  
  8.         });  

 

$http.get()方法是执行GET请求的一种捷径。***条参数是我们希望访问的URL。第二条参数则代表一个具备选项的对象。这里我们只需要params对象——它是一个查询参数散列,将被添加到该请求当中(其中q参数属于搜索字符串,大家可以点击此处了解更多相关信息)。

$http.get()会返回一项承诺。我们可以将监听器附加在success()与error()上,并且据此调用回调函数。

第六步:搜索栏

为了使用我们在之前几步中定义完成的函数,我们需要在自己的HTML当中添加搜索栏。相关代码非常简单,如下所示:

 

  1. <div id="search"> 
  2.     <input ng-model="query" placeholder="search" ng-keyup="$event.keyCode == 13 && executeSearch()"> 
  3.     <div class="repo" ng-repeat="repo in repos" ng-click="openRepo(repo.full_name)"> 
  4.         <strong>{{ repo.full_name }}</strong> 
  5.         <p>{{ repo.description }}</p> 
  6.     </div> 
  7. </div> 

 

我们使用ngModel指令将该输入栏中的值指向至Scope query变量,并在用户按下回车键后利用ngKeyup调用executeSearch()函数(这样$event.keyCode == 13就会进行比较)。我们无法在AngularJS表达式中使用条件语句,但一条简单的逻辑运算符(AND)足以很好地完成这项任务。

在输入域下面,我们使用ngRepeat来显示搜索结果。我们将显示该库的完整名称与描述(如果需要显示其它不同内容,大家可以点击此处查看GitHub API说明文档中的可用域)。

我们还使用ngClick通过该库的完整名称来调用openRepo()函数,这样我们就能显示与之相关的信息。我们稍后再对该函数进行定义。

#p#

第七步:使用搜索功能

现在我们终于可以使用自己创建完成的服务了。首先,将GitHub参数添加至控制器函数(这样该服务就能被注入到AngularJS当中):

  1. app.controller('SearchController'function SearchController($scope) { 

现在定义executeSearch()函数:

 

  1. $scope.executeSearch = function executeSearch() {  
  2.     GitHub.searchRepos($scope.query, function (error, data) {  
  3.         if (!error) {  
  4.             $scope.repos = data.items;  
  5.         }  
  6.     });  

 

如大家所见,我们利用来自$scope.query的搜索字符串从当中调用GitHub.searchRepos(),而后在回调中将搜索结果(来自data.items)加入$scope.repos变量。

只要执行以上步骤,我们就能顺利显示出搜索结果。在浏览器中打开我们的HTML文件并尝试进行搜索:

 

第八步:获取库中的数据

现在我们已经获得了搜索功能,可以显示出库中用户所选定的信息内容。下面我们再创建一条函数,旨在通过自己的服务获取来自库的数据:

 

  1. getRepo: function getRepo(name, callback) {  
  2.     $http.get('https://api.github.com/repos/'+ name)  
  3.         .success(function (data) {  
  4.             callback(null, data);  
  5.         })  
  6.         .error(function (e) {  
  7.             callback(e);  
  8.         });  
  9.     }  

被传递至此函数的名称必须为完整名称(结构为:作者名称、斜杠、库名称——例如angular/angular.js),这是因为我们需要将其传递至GitHub API(点击此处查看更多说明)。

第九步:获取库中的README文件

README文件中的内容并未被包含在我们利用以上函数获取到的数据当中。相反,大家需要利用另一个API进行调用及获取,因此我们需要创建以下函数:

  1. getReadme: function getReadme(name, callback) {  
  2.     $http.get('https://api.github.com/repos/'+ name +'/readme')  
  3.         .success(function (data) {  
  4.             callback(null, atob(data.content));  
  5.         })  
  6.         .error(function (e) {  
  7.             callback(e);  
  8.         });  

这条函数与之前我们创建完毕的两条基本相同,只不过对URL进行了变更。我们还要利用atob()函数解码README文件的内容,因为它采用base64编码机制。大家可以点击此处查看GitHub API说明文档中与获取README文件内容相关的信息。

我们之所以没有将这两条请求塞进同一个函数当中,是因为某些库根本不具备 README文件。如果我们将二者强行结合,应用程序可能因此发生故障。

第十步:显示库信息

我们将在另一个元素<div>当中显示库的完整名称、查看过该库的人数以及README文件:

 

  1. <div id="repo" ng-show="activeRepo"> 
  2.     <strong>{{ activeRepo.full_name }}</strong> <em>Watched by {{ activeRepo.watchers_count }} people.</em> 
  3.     <pre>{{ activeRepo.readme }}</pre> 
  4. </div> 

 

我们将把该信息保存在控制器Scope内的activeRepo变量当中。只要存在可以显示的数据,ngShow就会将该元素显示出来(如果不存在可以显示的数据,我们将只能看到‘Watched by people’文本,而且没有任何库被选中)。

第十一步:更新控制器

我们还需要对控制器进行更新,从而保证其切实获取到库数据并将其纳入Scope当中。下面创建我们之前附加至ngClick指令的openRepo()函数:

 

  1. $scope.openRepo = function openRepo(name) {  
  2.     GitHub.getRepo(name, function (error, data) {  
  3.         if (!error) {  
  4.             $scope.activeRepo = data;  
  5.    
  6.             GitHub.getReadme(name, function (error, data) {  
  7.                 if (!error) {  
  8.                     $scope.activeRepo.readme = data;  
  9.                 } else {  
  10.                     $scope.activeRepo.readme = 'No README found!';  
  11.                 }  
  12.             });  
  13.         }  
  14.     });  

 

如大家所见,我们首先使用GitHub.getRepo()方法、检查错误而后将该数据引入activeRepo变量。接下来,我们获取README文件——如果该文件不存在,我们需要向用户提示该情况。

现在大家可以再次运行自己的应用程序并查看其实际效果:

 

第十二步:获取用户的库

为了将更多功能引入到我们的应用程序当中,我们将为屏幕右方已被选定库的持有者显示其所有可用库。这要求我们向服务中引入另一个方法:

 

  1. getUserRepos: function getUser(name, callback) {  
  2.     $http.get('https://api.github.com/users/'+ name +'/repos')  
  3.         .success(function (data) {  
  4.             callback(null, data);  
  5.         })  
  6.         .error(function (e) {  
  7.             callback(e);  
  8.         });  

 

其内容与此前的几条几乎无甚差别(大家可以点击此处查看更多与此API请求相关的信息)。

第十三步:显示用户的库

这基本上相当于重现HTML中的搜索栏机制,不过我们实际需要显示的是用户名称与user对象中的库,而非输入域或者Scope本身:

 

  1. <div id="user"> 
  2.     <strong>{{ user.login }}</strong> 
  3.     <div class="repo" ng-repeat="repo in user.repos" ng-click="openRepo(repo.full_name)"> 
  4.         <strong>{{ repo.name }}</strong> 
  5.         <p>{{ repo.description }}</p> 
  6.     </div> 
  7. </div> 

 

到了这一步,大家应该已经拥有了一套能够切实运作的AngularJS应用程序——它可以根据搜索字符串获取GitHub库。大家可以进一步对其进行迭代,例如向其中添加更多功能或者为其设计完全不同的外观样式。

欢迎大家在评论栏中留下自己的实践心得、疑问、评论以及反馈意见!

英文:http://code.tutsplus.com/tutorials/accessing-external-apis-using-angularjss-services--cms-21884

责任编辑:林师授 来源: 51CTO
相关推荐

2014-10-13 13:44:00

AngularJS2048

2022-08-09 12:27:37

API集成微服务

2015-11-27 09:18:11

AngularJSWeb应用

2009-12-10 14:04:18

静态路由器

2019-11-13 11:52:46

区块链API比特币

2022-06-02 10:41:45

智能家居设备安全移动安全

2016-02-15 10:18:11

2011-12-23 09:28:31

Java

2023-10-11 09:54:59

Java开发

2022-09-28 07:18:34

服务限流部署

2023-07-26 17:13:38

2018-02-10 10:22:08

2021-10-14 06:51:55

云原生AWS安全

2023-12-11 15:12:12

2022-09-28 09:43:35

服务限流

2020-04-17 10:14:47

人工智能AI客户服务

2013-05-13 09:24:11

2015-03-12 09:05:22

NAT广域网IP地址

2020-11-02 08:23:36

shell脚本Linux

2009-12-28 15:50:23

AnyMedia接入系
点赞
收藏

51CTO技术栈公众号