[关闭]
@artman328 2017-12-19T11:40:50.000000Z 字数 9824 阅读 982

Bani Yas 应用开发步骤

wsc wsc45

一、后台 Web 服务 API 开发

1、Web 环境的建立

(1) 安装 XAMPP 应用

将 XAMPP 应用安装到某个文件夹，比如：f:\xampp ，然后修改环境变量 path , 将 f:\xampp\php 及 f:\xampp\mysql\bin 加到 path 中。

(2) 安装 Laravel 应用

将 Laravel 框架安装到某个文件夹，或直接将提供的 Laravel 框架文件拷贝到此文件夹。如果是拷贝的，请在这个文件夹中的命令行执行：

  1. php artisan key:generate

以重新生成应用程序的键。

(3) 配置站点

在 f:\xampp\apache\conf\httpd.conf 文件的尾部，加入以下内容（此处假定你的 Laravel 项目在 f:\php_projects\86_Server_A 下）：

  1. <Directory "F:/php_projects/86_Server_A/public">
  2.         AllowOverride all
  3.         Require all granted
  4. </Directory>
  5. Alias /86_Server_A "F:/php_projects/86_Server_A/public/"

然后，在 F:\php_projects\86_Server_A\public\.htaccess 文件中加入 RewriteBase 一行：

  1. <IfModule mod_rewrite.c>
  2.     <IfModule mod_negotiation.c>
  3.         Options -MultiViews -Indexes
  4.     </IfModule>
  6.     RewriteEngine On
  8.     # 加入下面一行
  9.     RewriteBase /86_Server_A  
  11.     # Handle Authorization Header
  12.     RewriteCond %{HTTP:Authorization} .
  13.     RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
  15.     # Redirect Trailing Slashes If Not A Folder...
  16.     RewriteCond %{REQUEST_FILENAME} !-d
  17.     RewriteCond %{REQUEST_URI} (.+)/$
  18.     RewriteRule ^ %1 [L,R=301]
  20.     # Handle Front Controller...
  21.     RewriteCond %{REQUEST_FILENAME} !-d
  22.     RewriteCond %{REQUEST_FILENAME} !-f
  23.     RewriteRule ^ index.php [L]
  24. </IfModule>

然后，重新启动 xampp 的 apache 服务器，在浏览器中输入：

  1. http://localhost/86_Server_A

应该能够看到 laravel 应用程序的默认首页。如果不行，请认真核对以上步骤。

2、数据准备

修改提供的 sql 脚本文件，建立相应的外键关联，加入必须的表定义。修改后内容如下：

  1. -- phpMyAdmin SQL Dump
  2. -- version 4.7.0
  3. -- https://www.phpmyadmin.net/
  4. --
  5. -- Host: 127.0.0.1
  6. -- Generation Time: Oct 10, 2017 at 05:46 AM
  7. -- Server version: 10.1.26-MariaDB
  8. -- PHP Version: 7.1.8
  10. SET SQL_MODE = "NO_AUTO_VALUE_ON_ZERO";
  11. SET AUTOCOMMIT = 0;
  12. START TRANSACTION;
  13. SET time_zone = "+00:00";
  17. DROP DATABASE IF EXISTS baniyas_db;
  18. CREATE DATABASE IF NOT EXISTS baniyas_db DEFAULT CHARSET utf8;
  19. USE baniyas_db;
  22. /*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
  23. /*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
  24. /*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
  25. /*!40101 SET NAMES utf8mb4 */;
  27. --
  28. -- Database: `worldskills_2017_serverside_default`
  29. --
  31. -- --------------------------------------------------------
  33. --
  34. -- Table structure for table `places`
  35. --
  37. CREATE TABLE `places` (
  38.   `id` int(11) NOT NULL,
  39.   `name` varchar(100) DEFAULT NULL,
  40.   `latitude` float DEFAULT NULL,
  41.   `longitude` float DEFAULT NULL,
  42.   `x` int(11) DEFAULT NULL,
  43.   `y` int(11) DEFAULT NULL,
  44.   `image_path` varchar(50) DEFAULT NULL,
  45.   `description` text
  46. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
  48. -- --------------------------------------------------------
  50. --
  51. -- Table structure for table `schedules`
  52. --
  54. CREATE TABLE `schedules` (
  55.   `id` int(11) NOT NULL,
  56.   `type` enum('TRAIN','BUS') DEFAULT 'TRAIN',
  57.   `line` int(11) DEFAULT NULL,
  58.   `from_place_id` int(11) NOT NULL,
  59.   `to_place_id` int(11) NOT NULL,
  60.   `departure_time` time DEFAULT NULL,
  61.   `arrival_time` time DEFAULT NULL,
  62.   `distance` int(11) DEFAULT NULL,
  63.   `speed` int(11) DEFAULT NULL,
  64.   `status` enum('AVAILABLE','UNAVAILABLE') DEFAULT 'AVAILABLE'  
  65. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
  67. --
  68. -- Indexes for dumped tables
  69. --
  71. --
  72. -- Indexes for table `places`
  73. --
  74. ALTER TABLE `places`
  75.   ADD PRIMARY KEY (`id`);
  77. --
  78. -- Indexes for table `schedules`
  79. --
  80. ALTER TABLE `schedules`
  81.   ADD PRIMARY KEY (`id`);
  84. --
  85. -- AUTO_INCREMENT for dumped tables
  86. --
  88. --
  89. -- AUTO_INCREMENT for table `places`
  90. --
  91. ALTER TABLE `places`
  92.   MODIFY `id` int(11) NOT NULL AUTO_INCREMENT;
  95. -- **** 以下为加入内容 *************************** -------
  97. ALTER TABLE `schedules`
  98.   ADD foreign key(`from_place_id`) references `places`(`id`);
  99. ALTER TABLE `schedules`
  100.   ADD foreign key(`to_place_id`) references `places`(`id`);
  102. -- ************************************** --
  104. --
  105. -- AUTO_INCREMENT for table `schedules`
  106. --
  107. ALTER TABLE `schedules`
  108.   MODIFY `id` int(11) NOT NULL AUTO_INCREMENT;
  110. /*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
  111. /*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
  112. /*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
  114. -- ** 增加用户表定义 ** --
  116. CREATE TABLE users(
  117.     `id` int(11) NOT NULL AUTO_INCREMENT PRIMARY KEY,
  118.     `username` varchar(30) NOT NULL UNIQUE,
  119.     `password` varchar(100),
  120.     `role` varchar(50) NOT NULL DEFAULT 'USER'
  121. );
  123. -- *************************** --
  126. -- ** 插入测试所需数据 **--
  127. INSERT INTO users
  128. VALUES
  129. (1,'admin','adminpass','ADMIN'),
  130. (2,'user1','user1pass','USER'),
  131. (3,'user2','user2pass','USER')
  132. ;
  133. -- ******************** --
  135. -- ** 增加旅行路线历史记录表定义 ** --
  136. CREATE TABLE route_histories(
  137.     id int(11) not null AUTO_INCREMENT PRIMARY KEY,
  138.     from_id int(11) NOT NULL,
  139.     to_id int(11) NOT NULL,
  140.     schedule_ids varchar(200),
  141.     count int default 0,
  142.     FOREIGN KEY(from_id) REFERENCES `places`(`id`),
  143.     FOREIGN KEY(to_id) REFERENCES `places`(`id`)
  144. );
  145. -- **************************** --
  147. -- ** 增加地点搜索历史记录表定义 ** --
  148. CREATE TABLE place_histories(
  149.     id int(11) not null AUTO_INCREMENT PRIMARY KEY,
  150.     user_id int(11) not null,
  151.     place_id int(11) not null,
  152.     count int default 0,
  153.     unique (user_id,place_id),
  154.     foreign key(user_id) references `users`(`id`),
  155.     foreign key(place_id) references `places`(`id`)
  156. );
  157. -- ***************************** --
  161. -- ** 载入提供的地点数据 **--
  162. load data local infile "d:/csv/place.csv"
  163. into table places
  164. fields terminated by ','
  165. lines terminated by '\r\n'
  166. ignore 1 lines;
  168. -- ** 载入提供的运行时刻数据 ** --
  169. load data local infile "d:/csv/schedule.csv"
  170. into table schedules
  171. fields terminated by ','
  172. lines terminated by '\r\n'
  173. ignore 1 lines;
  174. --******************** --
  176. -- ** 提交修改 ** --
  177. COMMIT;
  178. -- ************** --

在命令行中执行：

  1. mysql -uroot -p

登录 mysql 客户端，执行以下命令（假定以上内容在 D:\baniyas.sql 文件中）：

  1. source d:/baniyas_db.sql

如果输出显示执行无误，可进行下一步。

3、确定路由分组

编辑项目文件夹下的 routes 文件夹中的 web.php 路由文件，内容如下：

  1. <?php
  2. Route::get('/', function () {
  3.     return view('welcome');
  4. });
  6. Route::get("/api/v1/auth/unauthorized","LoginController@unauthorized");
  8. Route::post("/api/v1/auth/login", "LoginController@login");
  10. // API for User and Admin
  11. Route::prefix("/api/v1/")->middleware(['check.token'])->group(function(){
  12.     //次分组加入需要用户登录才能使用的功能
  13.     Route::get("auth/logout","LoginController@logout");
  14. });
  16. // API for Admin
  17. Route::prefix("/api/v1/")->middleware(['check.token','check.role'])->group(function(){
  18.     //次分组加入需要用户登录且角色为 ADMIN 才能使用的功能
  19. });

此文件的路由组定义中，需要用到两个中间件：check.token 和 check.role，还需要一个控制器类：LoginController。我们在后面分别创建它们。

4、创建中间件

利用以下命令分别创建两个中间件。
CheckToken:

  1. F:\php_projects\86_Server_A> php artisan make:middleware CheckToken

CheckRole:

  1. F:\php_projects\86_Server_A> php artisan make:middleware CheckRole

两个文件在 F:\php_projects\86_Server_A\app\Http\Middleware 文件夹中。

CheckToken.php 内容：

  1. <?php
  3. namespace App\Http\Middleware;
  5. use Closure;
  7. class CheckToken
  8. {
  9.     /**
  10.      * Handle an incoming request.
  11.      *
  12.      * @param  \Illuminate\Http\Request  $request
  13.      * @param  \Closure  $next
  14.      * @return mixed
  15.      */
  16.     public function handle($request, Closure $next)
  17.     {
  18.         $token1 = $request->input("token"); //客户端发送的 token
  19.         $token2 = session()->get("token"); //服务器端存储的 token
  20.         //如果客户端没有传来 token
  21.         //或者传来的 token 与服务器端的 token 不符
  22.         if(!$token1 || $token1!==$token2){
  23.             //请求被重定向
  24.             return redirect("/api/v1/auth/unauthorized");
  25.         }
  26.         //把请求继续向下传递
  27.         return $next($request);
  28.     }
  29. }

CheckRole.php 内容：

  1. <?php
  3. namespace App\Http\Middleware;
  5. use Closure;
  7. class CheckRole
  8. {
  9.     /**
  10.      * Handle an incoming request.
  11.      *
  12.      * @param  \Illuminate\Http\Request  $request
  13.      * @param  \Closure  $next
  14.      * @return mixed
  15.      */
  16.     public function handle($request, Closure $next)
  17.     {
  18.         //取出服务器端保存的用户角色名称
  19.         $role = session()->get("role"); 
  20.         //如果没有保存过的huo或者保存的名称不是 ADMIN
  21.         if(!$role || $role !== "ADMIN"){
  22.             //请求被重定向
  23.             return redirect("/api/v1/auth/unauthorized");
  24.         }
  25.         //把请求继续向下传递
  26.         return $next($request);
  27.     }
  28. }

5、配置中间件

修改 F:\php_projects\86_Server_A\app\Http\Kernel.php 文件，内容如下：

  1. <?php
  3. namespace App\Http;
  5. use Illuminate\Foundation\Http\Kernel as HttpKernel;
  7. class Kernel extends HttpKernel
  8. {
  9.     /**
  10.      * The application's global HTTP middleware stack.
  11.      *
  12.      * These middleware are run during every request to your application.
  13.      这些中间件是所有请求都要按顺序经过的
  14.      *
  15.      * @var array
  16.      */
  17.     protected $middleware = [
  18.         \Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
  19.         \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,
  20.         \App\Http\Middleware\TrimStrings::class,
  21.         \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,
  22.         \App\Http\Middleware\TrustProxies::class,
  23.     ];
  25.     /**
  26.      * The application's route middleware groups.
  27.      * 这些中间件被归类到一个组，共同加给特定路由。web.php 中的所有路由都要经过 web 中间件分组。
  28.      * @var array
  29.      */
  30.     protected $middlewareGroups = [
  31.         'web' => [
  32.             \App\Http\Middleware\EncryptCookies::class,
  33.             \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
  34.             \Illuminate\Session\Middleware\StartSession::class,
  35.             // \Illuminate\Session\Middleware\AuthenticateSession::class,
  36.             \Illuminate\View\Middleware\ShareErrorsFromSession::class,
  37.             //我们需要把下面这个中间件注释掉（不让请求经过它）
  38.             //\App\Http\Middleware\VerifyCsrfToken::class,
  39.             \Illuminate\Routing\Middleware\SubstituteBindings::class,
  40.         ],
  42.         'api' => [
  43.             'throttle:60,1',
  44.             'bindings',
  45.         ],
  46.     ];
  48.     /**
  49.      * The application's route middleware.
  50.      *
  51.      * These middleware may be assigned to groups or used individually.
  52.      *
  53.      * @var array
  54.      */
  55.     protected $routeMiddleware = [
  56.         'auth' => \Illuminate\Auth\Middleware\Authenticate::class,
  57.         'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
  58.         'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,
  59.         'can' => \Illuminate\Auth\Middleware\Authorize::class,
  60.         'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,
  61.         'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
  62.         //把我们的两个中间件在此注册，才可以在路由中指定使用
  63.         'check.token' => \App\Http\Middleware\CheckToken::class,
  64.         'check.role' => \App\Http\Middleware\CheckRole::class,
  65.     ];
  66. }

6、创建控制器

在命令行执行：

  1. F:\php_projects\86_Server_A> php artisan make:controller LoginController

得到文件 F:\php_projects\86_Server_A\app\Http\Controllers\LoginController.php，内容如下：

  1. <?php
  3. namespace App\Http\Controllers;
  5. use Illuminate\Http\Request;
  7. class LoginController extends Controller
  8. {
  9.     //
  10. }

将三个相应处理路由的函数实现，内容如下：

  1. <?php
  3. namespace App\Http\Controllers;
  5. use Illuminate\Http\Request;
  7. class LoginController extends Controller
  8. {
  9.     public function login(Request $request){
  10.         // 从请求获取用户名和密码
  11.         $username = $request->input("username");
  12.         $password = $request->input("password");
  13.         // 从数据库检索具有此用户名和密码的第一位用户（应当只有一位，first()取出了它）
  14.         $user = User::where("username",$username)->where("password",$password)->first();
  15.         // 如果用户存在
  16.         if($user){
  17.             // 将登录的用户对象信息保存在会话对象中并保存
  18.             session()->put('token',md5($username));
  19.             session()->put('role',md5($user->role));
  20.             session()->save();
  21.             // 返回数据与状态码：200
  22.             return response()->json(['token'=>md5($username),'role'=>$user->role],200);
  23.         }
  24.         // 如果没有从以上返回语句返回，说明用户不存在，返回错误信息的状态码：401
  25.         return response()->json(['message'=>"invalid login"],401);
  26.     }
  28.     public function logout(){
  29.         // 清除会话记录
  30.         session()->flush();
  31.         return response()->json(["message"=>"logout success"],200);
  32.     }
  34.     public function unauthorized(){
  35.         return response()->json(["message"=>"Unauthorized user"],401);
  36.     }
  37. }

7、测试API

打开素材提供的 Testing_Server_A.postman_collection.json 文件，将其中的 <server> 用 localhost 替换，将其中的 <XX> 及 XX 用 86 替换。
打开 Postman，用 Import 菜单引入以上文件，对其中的各个请求写出相应测试，即可进行 API 测试了。

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注