總體思路
thinkphp通過RESTful方式提供數據給angular,前端(包括模板頁面)全部由angular來接管。
示例
實現一個用戶管理模塊,走通增刪改查4個操作,通過該示例,演示如何在thinkphp中使用AngularJS。
一. 准備工作
1. 加載所需的js和css文件
angular.min.js angular 核心庫文件
angular-ui-router.min.js angular 路由插件
angular-resource.min.js 負責與服務端restful交互的插件
layer 彈窗插件,該插件依賴於jQuery-1.10.1.min.js和jquery-ui.min.js兩個庫文件以及一個jquery-ui.min.css樣式表
bootstrap.min.css bootstrap 核心樣式表
文件結構如下:
2. 引導頁
准備一個angular引導頁,angular通過該引導頁開啟一個angular應用,后續所有的操作,都是基於該引導頁進行的。
友情提醒:
這里的引導頁,其實就是我們應用的默認頁面,具體到thinkphp中,指的就是DEFAULT_MODULE/DEFAULT_CONTROLLER/DEFAULT_ACTION對應的模板文件。第一次訪問應用時,thinkphp控制器會定向到該頁面,之后的模板頁面,全部由angular接管,跟thinkphp的模板引擎就沒有半點關系了。
3. 應用首頁
在引導頁中通過<div ui-view="main"></div>包含我們的應用首頁。便簽的含義后面會有解釋。
注意:這一步不是必須的,因為你也可以把應用首頁的內容,全部放在引導頁中,但是這樣做就不夠友好了。
4. 搭建RESTFul環境
為了能夠使用$resource,我們必須讓服務端按照RESTful的方式來工作,否則,$resource就無法發揮其作用了。
thinkphp中內置了對RESTful的支持,使用方式也很簡單,就是讓某個Controller繼承自RestController,然后按照一定的規則來編寫資源方法即可。但是它有一個缺點,thinkphp內置的RESTful對資源的訪問方式不夠友好,其訪問資源的URL結構如下:
/模塊名稱/控制器名稱/資源名稱
基於此,我們考慮使用thinkphp的路由功能,來實現對RESTful的支持,使用thinkphp的路由功能時,控制器是沒有必要繼承RestController的,但為了尊重tp的勞動成果,同時,為了兼顧友好的資源訪問方式,最終,我使用的是RestController+路由兩者結合的方式。
補充:
資源方法的命名規則為:資源名稱_REST類型
REST類型有如下幾種:get,post,put,delete
5. 創建數據庫表
創建用戶表,並初始化一些數據
- DROP TABLE IF EXISTS `an_user`;
- CREATE TABLE `an_user` (
- `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
- `user_id` int(10) unsigned NOT NULL COMMENT '用戶id',
- `user_name` varchar(100) NOT NULL COMMENT '用戶名稱',
- `email` varchar(255) DEFAULT NULL COMMENT '郵箱地址',
- `tel` varchar(255) DEFAULT NULL COMMENT '手機號碼',
- `weixin` varchar(255) DEFAULT NULL COMMENT '微信號',
- `qq` varchar(255) DEFAULT NULL COMMENT 'qq號碼',
- PRIMARY KEY (`id`)
- ) ENGINE=INNODB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8 COMMENT='用戶表';
- INSERT INTO `an_user` VALUES ('1', '1', 'demo1', 'demo1@qq.com', '13100000000', 'weixin_test1', '123456');
- INSERT INTO `an_user` VALUES ('2', '2', 'demo2', 'demo2@qq.com', '13100000001', 'weixin_test2', '123456');
- INSERT INTO `an_user` VALUES ('3', '3', 'demo3', 'demo3@qq.com', '13100000002', 'weixin_test3', '123456');
- INSERT INTO `an_user` VALUES ('4', '4', 'demo4', 'demo4@qq.com', '13100000003', 'weixin_test4', '123456');
- INSERT INTO `an_user` VALUES ('5', '5', 'demo5', 'demo5@qq.com', '13100000004', 'weixin_test5', '123456');
- INSERT INTO `an_user` VALUES ('6', '6', 'demo6', 'demo6@qq.com', '13100000005', 'weixin_test6', '123456');
- INSERT INTO `an_user` VALUES ('7', '7', 'demo7', 'demo7@qq.com', '13100000006', 'weixin_test7', '123456');
- INSERT INTO `an_user` VALUES ('8', '8', 'demo8', 'demo8@qq.com', '13100000007', 'weixin_test8', '123456');
- INSERT INTO `an_user` VALUES ('9', '9', 'demo9', 'demo9@qq.com', '13100000008', 'weixin_test9', '123456');
二. 開始吧
1. 創建引導頁
前面說過,引導頁其實就是我們應用的默認頁面,在我的項目中,默認頁面的文件路徑為:
/tpl/Admin/Index/index.html
在該文件中,加入如下內容:
- <!DOCTYPE html>
- <html ng-app="antp">
- <head>
- <meta charset="utf-8" />
- <title></title>
- <meta content="width=device-width, initial-scale=1.0" name="viewport" />
- <meta content="" name="author" />
- <link href="/public/css/bootstrap.min.css" rel="stylesheet" type="text/css" media="all">
- <link href="/public/css/jquery-ui.min.css" rel="stylesheet" type="text/css" media="all">
- <script type="text/javascript" src="/public/js/angular.min.js"></script>
- <script type="text/javascript" src="/public/js/angular-resource.min.js"></script>
- <script type="text/javascript" src="/public/js/angular-ui-router.min.js"></script>
- <script type="text/javascript" src="/public/js/jquery-1.10.1.min.js"></script>
- <script type="text/javascript" src="/public/js/jquery-ui.min.js"></script>
- <script type="text/javascript" src="/public/js/layer/layer.js"></script>
- <script type="text/javascript" src="/config.js"></script>
- <script type="text/javascript" src="/app.js"></script>
- <link rel="shortcut icon" href="favicon.ico" />
- </head>
- <body>
- <div class="container-fluid">
- <div class="row clearfix">
- <div class="col-md-12" style="float: none;display: block;margin-left: auto;margin-right: auto;">
- <div ui-view="main"></div>
- </div>
- </div>
- </div>
- </body>
- </html>
頁面中加載的js和css,除了config.js和app.js,其它的在前面都已經作了說明,這兩個后面也會說到。
注意html標簽中的ng-app指令,該指令的內容,就是angular要開啟的應用名稱。
2. 開啟應用
之前的index.html文件中,通過ng-app指令定義了一個應用名稱,定義完之后,我們還需要開啟它,開啟的方式也很簡單,我們需要創建一個js文件,名稱為app.js,在里面先加入如下內容:
- var app = angular.module("antp",["ui.router","ngResource"]);
其中,module的第二個參數,是angular的一些依賴包。
3. 配置路由
使用ui.router的路由功能,通過config預先配置好訪問url、該url對應的視圖模板以及控制器等信息,同樣是在app.js文件中,繼續加入如下內容:
- app.config(function($stateProvider, $urlRouterProvider, $locationProvider) {
- //啟用HTML5模式的路由,該模式下會去除URL中的#號
- //$locationProvider.html5Mode(true);
- //默認頁面,所有請求不到的資源,都會轉向到這個URL
- $urlRouterProvider.otherwise("/index");
- $stateProvider.state("user", {
- url: "/user",
- views: {
- main: {
- templateUrl: "tpl/Admin/User/index.html",
- controller: "UserCtroller"
- }
- }
- }).state("index", {
- url: "/index",
- views: {
- main: {
- templateUrl: "tpl/Admin/Index/main.html",
- controller: "MainCtroller"
- }
- }
- }).state("user-add", {
- url: "/user/add",
- views: {
- main: {
- templateUrl: "tpl/Admin/User/add.html",
- controller: "UserFormCtroller"
- }
- }
- }).state("user-edit", {
- url: "/user/edit/:user_id",
- views: {
- main: {
- templateUrl: "tpl/Admin/User/add.html",
- controller: "UserFormCtroller"
- }
- }
- });
- });
還記得之前引導頁中的ui-view="main"嗎?ui-view的名字,就是state中配置的views下面的屬性名稱。也許你會說,config里面配置了那么多的main,它是如何知道找的是哪個main?仔細看下代碼就知道了。
注意1:控制器controller我們並沒有手動寫在某個頁面的標簽上,而是統一配置在了config里。
注意2:每個視圖模板必須要對應一個控制器,並且這個控制器必須要被創建,否則,該視圖將無法展示。
注意3:不要把此處的控制器和thinkphp里面的控制器搞混,事實上,他們兩者之間沒有任何關系。
4. 引入每個模塊下的js
這里為了便於代碼管理與維護,我在每個模塊下面創建了一個js文件,每個模塊的js完成特定的功能,這些js同樣需要在app.js中被引入。
- document.write('<script type="text/javascript" src="/tpl/Admin/Index/main.js"></script>');
- document.write('<script type="text/javascript" src="/tpl/Admin/User/user.js"></script>');
5. 瀏覽器訪問
在瀏覽器地址欄中,輸入http://local.antp,將會看到如下效果:
仔細觀察下地址欄,我們輸入的是http://local.antp,但是卻自動變成了http://local.antp/#/index,知道為什么嗎?
首頁,引導頁中的<div ui-view="main"></div>,表示我需要路由到main這個視圖,但是,我們輸入的地址http://local.antp中,並沒有告訴angular到底是哪個main,發生這種情況的時候,angular就會定向到默認的視圖,默認的視圖由$urlRouterProvider.otherwise("/index");這一句來指定。
由於/index指向的是tpl/Admin/Index/main.html,所以此處就會把main.html對應的內容展示出來。
main.html文件內容:
- <div ng-include="'tpl/Admin/Public/header.html'"></div>
- <blockquote>
- <p>
- 我是默認頁面,所有請求不到的資源,都會到我這里來...
- </p>
- </blockquote>
其中,通過ng-include指令,引入了一個公共導航頁面,ng-include指令中雙引號內的單引號不可少,內容如下:
- <div style="margin-top:20px;">
- <nav class="navbar navbar-default" role="navigation">
- <div class="navbar-header">
- <a class="navbar-brand" href="#">Brand</a>
- </div>
- <div class="collapse navbar-collapse">
- <ul class="nav navbar-nav">
- <li class="active">
- <a ui-sref="user">用戶管理</a>
- </li>
- </ul>
- </div>
- </nav>
- </div>
6. 用戶列表
點擊導航中的【用戶管理】,即可跳轉到用戶列表頁面,如下:
該列表對應的視圖文件為tpl/Admin/User/index.html,內容如下:
- <div ng-include="'tpl/Admin/Public/header.html'"></div>
- <button type="button" class="btn btn-primary" ng-click="addAction()">新增</button>
- <table class="table table-bordered table-striped" style="margin-top:15px;">
- <thead>
- <tr>
- <th>用戶名</th>
- <th>郵箱</th>
- <th>手機號</th>
- <th>微信</th>
- <th>QQ</th>
- <th>操作</th>
- </tr>
- </thead>
- <tbody>
- <tr ng-repeat="user in data.user">
- <td>
- <a ui-sref="user-edit({user_id:user.user_id})" ng-bind="user.user_name"></a>
- </td>
- <td ng-bind="user.email"></td>
- <td ng-bind="user.tel"></td>
- <td ng-bind="user.weixin"></td>
- <td ng-bind="user.qq"></td>
- <td>
- <button type="button" class="btn btn-link">
- <a ui-sref="user-edit({user_id:user.user_id})">修改</a>
- </button>
- <button type="button" class="btn btn-link" ng-click="deleteAction(user.user_id)">刪除</button>
- </td>
- </tr>
- </tbody>
- </table>
為了能夠從后端拿到數據,我們需要創建一個$resource資源,創建方式如下:
- //通過factory創建一個service,該service通過$resource返回了一個資源對象
- //$resource負責與支持restful的服務端進行數據交互
- app.factory("UserService", function($resource) {
- return $resource(globalConfig.API.URL + "users/:id", {
- id: "@id"
- },
- {
- //query方法要求服務端返回的數據格式為數組,如果返回的是非數組格式,需要在transformResponse函數中作轉換處理
- query: {
- method: "GET",
- isArray: true,
- transformResponse: function(data) {
- return JSON.parse(data);
- }
- },
- update: {
- method: "PUT"
- }
- });
- });
這里,創建了一個名字為UserService的資源,然后,我們還需要創建一個控制器,將UserService資源注入進去,代碼如下:
- //用戶列表Ctroller
- app.controller('UserCtroller', function($scope, $state, UserService) {
- $scope.data = {};
- //獲取用戶列表
- UserService.query().$promise.then(
- function(data){
- //將查詢結果賦值給data.user,模板中可以對data.user變量進行遍歷
- $scope.data.user = data;
- },
- function(error) {
- console.log("An error occurred", error);
- }
- );
- $scope.addAction = function() {
- $state.go("user-add");
- };
- $scope.deleteAction = function(user_id){
- layer.confirm("確定要刪除該用戶嗎", {
- btn: ['確定','取消']
- }, function(index){
- layer.close(index);
- UserService.remove({id:user_id}).$promise.then(
- function(res){
- if(res.status){
- $state.go("user",null,{
- reload:true
- });
- }else{
- }
- },
- function(error) {
- console.log("An error occurred", error);
- }
- );
- });
- }
- });
通過UserService的query方法,獲取用戶列表信息。
7. 新增用戶
點擊列表上的【新增】,將會通過$state.Go("user-add");跳轉到新增頁面:
該頁面對應的視圖文件為tpl/Admin/User/add.html,內容如下:
- <div ng-include="'tpl/Admin/Public/header.html'"></div>
- <form class="form-horizontal" role="form" name="userForm">
- <div class="form-group">
- <label class="col-sm-3 control-label">用戶名</label>
- <div class="col-sm-4">
- <input type="text" class="form-control" ng-model="user.user_name"/>
- </div>
- </div>
- <div class="form-group">
- <label class="col-sm-3 control-label">郵箱</label>
- <div class="col-sm-4">
- <input type="email" class="form-control" ng-model="user.email"/>
- </div>
- </div>
- <div class="form-group">
- <label class="col-sm-3 control-label">手機號</label>
- <div class="col-sm-4">
- <input type="tel" class="form-control" ng-model="user.tel"/>
- </div>
- </div>
- <div class="form-group">
- <label class="col-sm-3 control-label">微信號</label>
- <div class="col-sm-4">
- <input type="text" class="form-control" ng-model="user.weixin"/>
- </div>
- </div>
- <div class="form-group">
- <label class="col-sm-3 control-label">QQ</label>
- <div class="col-sm-4">
- <input type="text" class="form-control" ng-model="user.qq"/>
- </div>
- </div>
- <div class="col-sm-offset-3 col-sm-4">
- <button type="submit" class="btn btn-primary" ng-click="submitAction(userForm)">
- 保存
- </button>
- <button type="button" class="btn btn-default" ng-click="cancelAction()">
- 返回
- </button>
- </div>
- </form>
該頁面中用到了angular的ng-model指令,ng-model指令用於數據的雙向綁定,注意下表單中類似於user.user_name的東西,首先,controller中會通過點號前面的user獲取表單數據,表單數據就是點號后面若干個類似於user_name的對應的內容的組合。
js代碼:
- //新增和修改用戶Ctroller
- app.controller('UserFormCtroller', function($scope, $state, $stateParams, UserService) {
- if($stateParams.user_id){
- var user_id = $stateParams.user_id;
- var param = {id:user_id};
- //獲取指定用戶
- UserService.get(param).$promise.then(
- function(res) {
- $scope.user = res;
- },
- function(error) {
- console.log("An error occurred", error);
- }
- );
- }
- $scope.submitAction = function(userForm) {
- if(!userForm.$valid){
- return false;
- }
- if($stateParams.user_id){
- //更新用戶信息
- UserService.update(param,$scope.user).$promise.then(
- function(res) {
- if(res.status){
- $state.go("user");
- }else{
- }
- },
- function(error) {
- console.log("An error occured", error);
- }
- );
- }else{
- //新增
- UserService.save($scope.user).$promise.then(
- function(res) {
- if(res.status){
- $state.go("user");
- }else{
- }
- },
- function(error) {
- console.log("An error occured", error);
- }
- );
- }
- };
- $scope.cancelAction = function() {
- $state.go("user");
- };
- });
通過UserService的save方法來新增一個用戶,而update方法則負責用戶信息的修改。
注意:在修改用戶的信息之前,我們需要通過UserService的get方法把用戶已有的信息填充到頁面上。
8. 修改用戶
點擊列表上的【修改】鏈接,進入到用戶修改頁面:
通過列表中的ui-sref="user-edit({user_id:user.user_id})"這一句,即可實現頁面的跳轉,同時,帶上了user_id這個參數,可以在控制器中注入$stateParams來獲取此處的參數,代碼在前面已經貼過了。
9. 刪除用戶
點擊列表上的【刪除】,將會彈出一個刪除確認的提示,如圖:
點擊【確定】后,即可通過UserService的remove方法來刪除該用戶。
注意:刪除一個資源,也可以使用delete方法,但由於delete在有些瀏覽器中被當成了關鍵字,所以使用上需要寫成UserService["delete"]這種格式。
10. thinkphp路由配置
- 'URL_ROUTER_ON' => true
- 'URL_ROUTE_RULES' => array(
- array('api/users/:id','Admin/User/user_get','',array('method'=>'get')),
- //注意:列表記錄對應的路由必須要放在單條記錄路由的后面,否則無法獲取單條記錄
- array('api/users','Admin/User/user_get','',array('method'=>'get')),
- array('api/users','Admin/User/user_post','',array('method'=>'post')),
- array('api/users/:id','Admin/User/user_put','',array('method'=>'put')),
- array('api/users/:id','Admin/User/user_delete','',array('method'=>'delete')),
- )
11. 后端代碼
- //查詢用戶列表或單條記錄
- public function user_get(){
- $id = I('id');
- if ($id) {
- $where = array('user_id' => $id);
- $users = DBUtil::queryRow($this->userModel,$where);
- }else{
- $users = DBUtil::queryList($this->userModel);
- }
- $this->response($users,'json');
- }
- //新增用戶
- public function user_post(){
- $user_id = DBUtil::getMaxKey($this->userModel, 'user_id');
- //angular默認post過來的數據類型為Content-Type:application/json; charset=utf-8
- $userData = json_decode(file_get_contents('php://input'),true);
- $userData['user_id'] = $user_id;
- $result = DBUtil::add($this->userModel, $userData);
- $this->response(array('status'=>$result),'json');
- }
- //修改用戶
- public function user_put(){
- $user_id = $_REQUEST['id'];
- //angular默認post過來的數據類型為Content-Type:application/json; charset=utf-8
- $userData = json_decode(file_get_contents('php://input'),true);
- $result = DBUtil::save($this->userModel, array('user_id' => $user_id), $userData);
- if ($result !== false) {
- $result = true;
- }
- $this->response(array('status'=>$result),'json');
- }
- //刪除用戶
- public function user_delete(){
- $user_id = $_REQUEST['id'];
- $result = DBUtil::delete($this->userModel, array('user_id' => $user_id));
- $this->response(array('status'=>$result),'json');
- }
三. 去除URL中的#號
默認情況下,angular通過URL中的#號來識別資源路徑類別,凡是帶#號的資源,統一由angular調配,而不帶#號的資源,由服務端調配,如果需要去除#號,可以參考以下步驟:
1. 啟用HTML5模式
首頁需要在config中注入$locationProvider,然后通過$locationProvider.html5Mode(true);來啟用html5模式的路由。
2. 加入base標簽
在引導頁中加入<base href="/">
3. 后端thinkphp配置
在控制器中增加一個_empty方法,在該方法中,跳轉到首頁。