如何在 Laravel 專案中輕鬆實現上傳頭像功能?

sevdot發表於2018-09-07

在 Web 開發中經常使用圖片上傳功能,目前有許多免費的資源可以讓開發者輕鬆實現圖片上傳功能,那如何在 laravel 專案中輕鬆實現上傳頭像功能呢?最近我在開發我的個人網站時就用到這個功能,下面我說說我的具體實現思路。

設計資料表欄位

我們需要在 users 使用者表裡面新增一個 avatar 欄位來存使用者的頭像地址,生成使用者表的遷移檔案 database/migrations/[timestamp]_create_users_table.php 中的程式碼如下:

<?php

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateUsersTable extends Migration
{
    /**
     * Run the migrations.
     *
     * @return void
     */
    public function up()
    {
        Schema::create('users', function (Blueprint $table) {
            $table->increments('id');
            $table->string('name');
            $table->string('email')->unique();
            $table->string('sex')->nullable();
            $table->string('phone')->unique()->nullable();
            $table->string('password')->nullable();
            $table->string('avatar')->nullable();
            $table->rememberToken();
            $table->timestamps();
        });
    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        Schema::dropIfExists('users');
    }
}

開啟頭像修改頁面

routes/web.php 中新增開啟修改頭像頁面的路由:

Route::get('users/{user}/edit_avatar','UsersController@editAvatar')->middleware('auth')->name('users.edit_avatar');

使用命令建立 UsersController 控制器,命令如下:

php artisan make:controller UsersController

該命令會在 app/Http/Controllers 下生成 UsersController.php 檔案,在 UsersController.php 中新增 editAvatar 方法,用以開啟修改頭像的頁面,程式碼如下:

<?php

namespace App\Http\Controllers;

use App\Handlers\ImageUploadHandler;
use App\Models\User;
use App\Notifications\EmailVerificationNotification;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Mail;

class UsersController extends Controller
{

    public function editAvatar(User $user)
    {
        return view('users.edit_avatar', compact('user'));
    }
}

修改頭像頁面如下:

image.png | left | 827x408

resources/views/users/edit_avatar.blade.php 檔案中實現這個介面,程式碼如下:

@extends('layouts.app')
@section('title')
    基本資訊
@stop
@section('content')
    <section class="section" >
        <div class="container">
            <div class="columns">
                <div class="column is-3">
                    <div class="card">
                        <div class="card-content">
                            <nav class="panel ">
                                <a class="panel-block" href="{{url('users/'.$user->id.'/edit')}}">
                            <span class="panel-icon">
                              <i class="fa fa-book" aria-hidden="true"></i>
                            </span>
                                    個人資訊
                                </a>
                                <a class="panel-block is-active"  href="{{ route('users.edit_avatar',$user->id) }}">
                            <span class="panel-icon">
                              <i class="fa fa-picture-o" aria-hidden="true"></i>
                            </span>
                                    修改頭像
                                </a>
                                <a class="panel-block" href="{{ route('users.edit_password',$user->id) }}">
                            <span class="panel-icon">
                              <i class="fa fa-lock" aria-hidden="true"></i>
                            </span>
                                    修改密碼
                                </a>
                                <div class="panel-block">
                                    <a class="button is-link is-outlined is-fullwidth">
                                        建議反饋
                                    </a>
                                </div>
                            </nav>
                        </div>
                    </div>
                </div>
                <div class="column is-9">
                    <div class="card">
                        <div class="card-content">
                            <h2 class="title is-4"><span class="icon"><i class="fa fa-picture-o"></i></span> 請選擇圖片</h2>
                            <hr>
                            @if(\Illuminate\Support\Facades\Session::has('mes'))
                                <p class="field">
                                   <span class="has-text-danger">
                                       {{\Illuminate\Support\Facades\Session::get('mes')}}
                                   </span>
                                </p>
                            @endif
                            <form action="{{route('users.update_avatar',$user->id)}}" method="post" enctype="multipart/form-data">
                                {{csrf_field()}}
                               <div class="columns">
                                   <div class="column is-3">
                                       <div class="">
                                           <strong>請選擇圖片:</strong>
                                           <figure class="image is-1by1"><img src="{{asset($user->avatar)}}"></figure>
                                       </div>
                                   </div>
                               </div>
                                <div class="columns">
                                    <div class="column is-3">
                                        <div class="file is-boxed">
                                            <label class="file-label">
                                                <input class="file-input" type="file" name="avatar">
                                                <span class="file-cta">
                                                  <span class="file-icon">
                                                    <i class="fa fa-upload"></i>
                                                  </span>
                                                  <span class="file-label">
                                                    選擇一張圖片
                                                  </span>
                                                </span>
                                            </label>
                                        </div>
                                    </div>
                                </div>
                                <div class="columns">
                                    <div class="column is-3">
                                        <button class="button is-link" type="submit">
                                            <span>上傳頭像</span>
                                        </button>
                                    </div>
                                </div>
                            </form>
                        </div>
                    </div>
                </div>
            </div>
        </div>
    </section>
@stop

上傳圖片並修改頭像

使用者點選選擇一張圖片按鈕後選中一張圖片,然後點選上傳頭像按鈕,即可修改頭像成功。接下來繼續實現上傳圖片功能,在
routes/web.php 中新增修改頭像路由:

Route::post('users/{user}/update_avatar','UsersController@updateAvatar')->middleware('auth')->name('users.update_avatar');

app/Htpp/Controllers/UsersController.php 中新增 updateAvatar方法,用以修改頭像,程式碼如下:

public function updateAvatar(User $user,Request $request,ImageUploadHandler $uploader)
{
    if ($request->avatar) {
        $result = $uploader->save($request->avatar, 'avatars', 1);
        if ($result) {
            $data['avatar'] = $result['path'];
        }
    }
    $user->avatar=$data['avatar'];
    $user->save();
    return redirect()->route('users.edit_avatar', $user->id)->with('success', '更新成功');
}

細心的你可能已經注意到了,這裡引入一個 ImageUploadHandler 類,並用它的 save 方法來處理圖片上傳,該類的程式碼也很簡單,程式碼如下:

app/Handlers/ImageUploadHandler.php

<?php
namespace App\Handlers;

class ImageUploadHandler
{
    // 只允許以下字尾名的圖片檔案上傳
    protected $allowed_ext = ["png", "jpg", "gif", 'jpeg'];

    public function save($file, $folder, $file_prefix)
    {
        // 構建儲存的資料夾規則,值如:uploads/images/avatars/201709/21/
        // 資料夾切割能讓查詢效率更高。
        $folder_name = "uploads/images/$folder/" . date("Ym/d", time());

        // 檔案具體儲存的物理路徑,`public_path()` 獲取的是 `public` 資料夾的物理路徑。
        // 值如:/home/vagrant/Code/larabbs/public/uploads/images/avatars/201709/21/
        $upload_path = public_path() . '/' . $folder_name;

        // 獲取檔案的字尾名,因圖片從剪貼簿裡黏貼時字尾名為空,所以此處確保字尾一直存在
        $extension = strtolower($file->getClientOriginalExtension()) ?: 'png';

        // 拼接檔名,加字首是為了增加辨析度,字首可以是相關資料模型的 ID
        // 值如:1_1493521050_7BVc9v9ujP.png
        $filename = $file_prefix . '_' . time() . '_' . str_random(10) . '.' . $extension;

        // 如果上傳的不是圖片將終止操作
        if ( ! in_array($extension, $this->allowed_ext)) {
            return false;
        }

        // 將圖片移動到我們的目標儲存路徑中
        $file->move($upload_path, $filename);

        return [
            'path' => config('app.url') . "/$folder_name/$filename"
        ];
    }

}

實現效果如下:

image.png | left | 827x410

至此簡單的頭像上傳功能已然完成,各位大神可能會覺得很簡單,要的就是簡單,寫這樣的文章是為了增強自己的記憶,同時給初學者一些參考,後面我會接著寫如何在評論裡面實現拖拽/貼上上傳圖片。

相關文章