Edited at

Laravel5.5こと始め 〜8. Vue.jsとAPIベースのユーザ管理アプリの追加〜

More than 1 year has passed since last update.


内容

以下の順番にまとめます。

1. MacへのXAMPP+Laravelインストール

2. ユーザログイン機能の追加

3. MVCとルーティングの説明

4. ユーザリストの表示

5. ユーザリストのペジネーション表示

6. ユーザ管理APIの追加

7. Vue.jsとAPIベースのユーザ管理アプリの追加準備

8. Vue.jsとAPIベースのユーザ管理アプリの追加 ←いまここ

9. Vue.jsとAPIベースのユーザ管理アプリへのペジネーション追加

10. APIへのJWTAuth認証の追加

11. Vue.jsとAPIベースのユーザ管理アプリへの認証の追加


8. Vue.jsとAPIベースのユーザ管理アプリの追加

前回は、ログイン後 http://localhost:8000/home2 にアクセスすると「resources/views/home2.blade.php」が表示されるところまでを実装しましたが、ここではVue.jsのコンポーネントを作成します。

スクリーンショット 2018-07-18 16.05.08.png

Vue.jsのコンポーネントとは再利用可能なWebのUI部品のようなもので、上図で表したファイルに以下のルールでコードを作成して「npm run dev」というコマンドでコンパイルをするとHTMLの中で<router-view/>タグなどを差し込むことで、コンポーネントを使うことができるようになります。


Vueコンポーネントの作成ステップ


1. home2.blade.phpの作成(太緑枠)

下記の通りViewである「resources/views/home2.blade.php」を作成します。(こちらは「7. Vue.jsとAPIベースのユーザ管理アプリの追加準備」で作成しました)


resources/views/home2.blade.php

@extends('layouts.app')

@section('content')
<div class="container">
<div class="row">
<div class="col-md-8 col-md-offset-2">
<div class="panel panel-default">
<div class="panel-body">
<router-view/>
</div>
</div>
</div>
</div>
</div>
@endsection


「@extends('layouts.app')」は、「resources/views/layouts/app.blade.php」をページレイアウトとして定義して、「app.blade.php」に記載された「@yield('content')」部分に上記「home2.blade.php」の「@section('content')」から「@endsection」までのHTMLを入れ込んで表示することを表しています。

また、「app.blade.php」には「<script src="{{ asset('js/app.js') }}" defer></script>」と記載があるため、上図にあるようにVueで最終的に生成される("npm run dev"コマンドで生成される)「public/js/app.js」が読み込まれることになります。

さらに、「<router-view/>」タグはview-routerライブラリを使って作成するVueコンポーネントをセットすることを表します。


2. app.blade.phpの作成(細黒枠)

「resources/views/layouts/app.blade.php」はレイアウトとして使うため、すべてのページで呼び出されます。そのため、APIの認証のためのアクセストークンもこちらでセットします。


resources/views/layouts/app.blade.php

<!DOCTYPE html>

<html lang="{{ str_replace('_', '-', app()->getLocale()) }}">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">

<!-- CSRF Token -->
<meta name="csrf-token" content="{{ csrf_token() }}">
<!-- ここから追加 -->
<script>
window.Laravel = {};
window.Laravel.csrfToken = "{{ csrf_token() }}";
</script>
<!-- ここまで追加 -->

<title>{{ config('app.name', 'Laravel') }}</title>

<!-- Scripts -->
<script src="{{ asset('js/app.js') }}" defer></script>
... (以下省略)



3. app.jsの作成(赤枠)

Vueライブラリの読み込みと.vueファイルで定義するVueコンポーネントの名前定義やview-routerライブラリを使ったルーティング定義は「resources/assets/js/app.js」で行います。


resources/assets/js/app.js

require('./bootstrap');

import Vue from 'vue';
import VueRouter from 'vue-router';
Vue.use(VueRouter);
import http from './http.js';

const routes = [
{path:'/', component:require('./components/UsersIndex.vue'), name:'listUsers'},
{path:'/create', component:require('./components/UsersCreate.vue'), name:'createUser'},
{path:'/edit/:id', component:require('./components/UsersEdit.vue'), name:'editUser'},
]

const router = new VueRouter({ routes })
new Vue(Vue.util.extend({
router,
created () {
http.init()
},
})).$mount('#app');


「import VueRouter from 'vue-router';」で、VueRouterという名前でvue-routerライブラリのインスタンスを作成しています。


app.js

const routes = [

{path:'/', component:require('./components/UsersIndex.vue'), name:'listUsers'},
{path:'/create', component:require('./components/UsersCreate.vue'), name:'createUser'},
{path:'/edit/:id', component:require('./components/UsersEdit.vue'), name:'editUser'},
]

以上の定義により、URIが「http://localhost:8000/home2#/ 」だと「resources/assets/js/components/UsersIndex.vue」で定義された「listUsers」という名前の「UsersIndex」コンポーネントを「home2.blade.php」の「<router-view/>」タグに当てはめ、URIが「http://localhost:8000/home2#/create 」だと「resources/assets/js/components/UsersCreate.vue」で定義された「createUser」という名前の「UsersCreate」コンポーネントを「home2.blade.php」の「<router-view/>」タグに当てはめ、URIが「http://localhost:8000/home2#/edit/:id 」(:idにはユーザIDを当てはめます)だと「resources/assets/js/components/UsersEdit.vue」で定義された「editUser」という名前の「UsersEdit」コンポーネントを「home2.blade.php」の「<router-view/>」タグに当てはめることを表します。


4. http.jsの作成(細赤枠)

上記「app.js」内で「import http from './http.js';」と宣言されているAPI実行用のJavaScriptファイルを作成します。JSファイルとして分離することによって、初期設定などコードの見通しがよくなります。

APIへのアクセスはaxiosライブラリを利用しており、get,post,put,deleteメソッドのほか初期化関数initを実装しており、initではトークンなどヘッダー情報をセットしています。


resources/assets/js/http.js

import axios from 'axios'

export default {
request(method,url,data,successCb=null,errorCb=null) {
axios.request({
url,
data,
method: method.toLowerCase()
}).then(successCb).catch(errorCb)
},
get(url,successCb=null,errorCb=null){
return this.request('get',url,{},successCb,errorCb)
},
post(url,data,successCb=null,errorCb=null) {
return this.request('post',url,data,successCb,errorCb)
},
put(url,data,successCb=null,errorCb=null) {
return this.request('put',url,data,successCb,errorCb)
},
delete(url,data={},successCb=null,errorCb=null) {
return this.request('delete', url, data, successCb, errorCb)
},
init() {
axios.defaults.baseURL = 'http://localhost:8000/api'
axios.interceptors.request.use(config => {
config.headers['X-CSRF-TOKEN'] = window.Laravel.csrfToken
config.headers['X-Requested-With'] = 'XMLHttpRequest'
console.log(config)
return config
})
}
}


5. UsersIndex.vueの作成(青枠)


resources/assets/js/components/UsersIndex.vue

<template>

<div>
<div class="form-group">
<router-link :to="{name: 'createUser'}" class="btn btn-success">Create new user</router-link>
</div>
<div class="panel panel-default">
<div class="panel-body">
<table class="table table-bordered table-striped">
<thead>
<tr>
<th>Name</th>
<th>Email</th>
<th width="100">&nbsp;</th>
</tr>
</thead>
<tbody>
<tr v-for="user, index in users">
<td>{{ user.name }}</td>
<td>{{ user.email }}</td>
<td>
<router-link :to="{name:'editUser',params:{id:user.id}}" class="btn btn-xs btn-default">Edit</router-link>
<a href="#" class="btn btn-xs btn-danger" v-on:click="deleteEntry(user.id, index)">Delete</a>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</template>

<script>
import http from '../http.js'
export default {
data: function () {
return {
users: []
}
},
mounted() {
this.getResults();
},
methods: {
getResults() {
var app = this;
http.get('users',resp=>{
app.users = resp.data;
})
},
deleteEntry(id, index) {
if (confirm("Do you really want to delete it?")) {
var app = this;
http.delete('users/'+id,app.$router.go(0))
}
}
}
}
</script>



6. UsersCreate.vueの作成(青枠)


resources/assets/js/components/UsersCreate.vue

<template>

<form v-on:submit="saveForm()" class="p-form" autocomplete="off">
<section class="p-section">
<div class="p-section__header">
<h3 class="p-section__heading">Create new User</h3>
</div>
<dl class="p-row">
<dt>Name</dt>
<dd><input type="text" v-model="user.name" class="c-input"></dd>
</dl>
<dl class="p-row">
<dt>E-mail</dt>
<dd><input type="text" v-model="user.email" class="c-input"></dd>
</dl>
<dl class="p-row">
<dt>Password</dt>
<dd><input type="password" v-model="user.password" class="c-input"></dd>
</dl>
<ul class="p-buttons">
<router-link to="/" class="btn btn-default">Cancel</router-link>&nbsp;<button class="btn btn-success">Create</button>
</ul>
</section>
</form>
</template>

<script>
import http from '../http.js'
export default {
data: function () {
return {
user: {
name: '',
email: '',
password: '',
}
}
},
methods: {
saveForm() {
var app = this;
var newUser = app.user;
http.post('/users',newUser,app.$router.push({path: '/'}));
}
}
}
</script>



7. UsersEdit.vueの作成(青枠)


resources/assets/js/components/UsersEdit.vue

<template>

<form v-on:submit="saveForm()" class="p-form">
<section class="p-section">
<div class="p-section__header">
<h3 class="p-section__heading">Edit User</h3>
</div>
<dl class="p-row">
<dt>Name</dt>
<dd><input type="text" v-model="user.name" class="c-input"></dd>
</dl>
<dl class="p-row">
<dt>E-mail</dt>
<dd><input type="text" v-model="user.email" class="c-input"></dd>
</dl>
<ul class="p-buttons">
<router-link to="/" class="btn btn-default">Cancel</router-link>&nbsp;<button class="btn btn-success">Edit</button>
</ul>
</section>
</form>
</template>

<script>
import http from '../http.js'
export default {
data() {
return {
user: {}
}
},
mounted() {
http.get('users/'+this.$route.params.id,result=>{
this.user = result.data;
});
},
methods: {
saveForm() {
http.put('users/'+this.$route.params.id,this.user,resp=>{
alert("Edit successfully!");
this.$router.push({path: '/'});
})
}
}
}
</script>



8. 「npm run dev」コマンドの実行

$ npm run dev

DONE Compiled successfully in 4831ms 17:51:31

Asset Size Chunks Chunk Names
/js/app.js 1.46 MB 0 [emitted] [big] /js/app
/css/app.css 196 kB 0, 0 [emitted] /js/app, /js/app

これにより、「public/js/app.js」が作成されます。


ユーザ管理アプリの起動

実装したユーザ管理アプリをテストします。いつものように「php artisan serve」を実行して開発用サービスを開始します。


1. 「http://localhost:8000/home2 」にアクセスし、ログインします。

http://localhost:8000/home2 にアクセスするとログインしていない場合ログイン画面が表示されますのでログインします。

スクリーンショット 2018-06-30 19.05.08.png


2. ユーザリストが表示されます。

スクリーンショット 2018-06-30 19.05.28.png


3. ユーザを作成します。

「Create new user」ボタンを押下して、ユーザ情報を入力して「Create」ボタンを押下します。

スクリーンショット 2018-06-30 19.05.54.png

ユーザが追加されてリスト表示されます。

スクリーンショット 2018-06-30 19.13.56.png


4. ユーザ情報を編集します。

リストから編集したい行の「Edit」を押下して表示される「Edit User」画面でユーザ情報を編集し、「Edit」ボタンを押下します。

スクリーンショット 2018-06-30 19.15.19.png

確認ダイアログが表示されますので、OKボタンを押下します。

スクリーンショット 2018-06-30 19.15.30.png

編集された結果を反映したユーザ情報がリストされます。

スクリーンショット 2018-06-30 19.15.46.png


5. ユーザ情報を削除します。

リストから削除したいユーザのDeleteボタンを押下すると、確認ダイアログが表示されるのでOKボタンを押下します。

スクリーンショット 2018-06-30 19.16.05.png

削除が反映されて一覧が表示されます。

スクリーンショット 2018-06-30 19.16.18.png

以上、「8. Vue.jsとAPIベースのユーザ管理アプリの追加」が完了です。

次は、「9. Vue.jsとAPIベースのユーザ管理アプリへのペジネーション追加」です。