Visão geral
Neste tutorial, você aprenderá a usar o MongoDB em um aplicativo Laravel criando um sistema simples de alerta de tarefas. O aplicativo permite criar, ler, atualizar e excluir tarefas. Além disso, ele envia alertas por e-mail para as próximas tarefas com base em um horário agendado.
Pré-requisitos
Antes de iniciar este tutorial, verifique se você tem os seguintes componentes instalados em seu ambiente de desenvolvimento:
Você também deve configurar um cluster MongoDB Atlas . Para aprender como configurar um cluster, consulte o guia de primeiros passos.
Passos
Instale o pacote MongoDB Laravel .
Para usar o MongoDB em seu aplicativo, você deve instalar o pacote Laravel MongoDB e configurá-lo no arquivo config/database.php.
Instale o pacote usando o seguinte comando:
composer require mongodb/laravel-mongodbDica
Se você encontrar um erro ao executar o comando anterior, certifique-se de que a extensão MongoDB PHP esteja instalada. Para saber como instalar, consulte a etapa Instalar a extensão MongoDB PHP no guia de Introdução.
Configure a conexão do banco de dados .
Após a conclusão da instalação do pacote Laravel MongoDB , adicione sua conexão do banco de dados MongoDB ao arquivo config/database.php para concluir a configuração. Adicione a seguinte configuração MongoDB à array connections que contém configurações para outros tipos de banco de dados :
return [
'connections' => [
'mongodb' => [ 'driver' => 'mongodb', 'dsn' => env('MONGODB_URI'), 'database' => 'task_reminder', ],
// Other connections here ],
];Seu aplicativo obtém o valor dsn do arquivo .env. Navegue até seu arquivo .env. Em seguida, crie um valor para MONGODB_URI e defina-o para o valor da sua string de conexão do MongoDB .
Dica
Para obter sua string de conexão do MongoDB, navegue até seu cluster no MongoDB Atlas. Clique no botão Connect e clique no Drivers em Connect your application. Selecione "PHP" no menu de seleção Driver. Copie a string de conexão da caixa de diálogo. Para obter etapas detalhadas sobre como obter sua string de conexão, consulte Criar uma string de conexão.
Em seu arquivo .env, defina o valor DB_CONNECTION como mongodb para torná-la a conexão padrão do seu aplicativo. Edite o valor SESSION_DRIVER e defina-o para mongodb conforme mostrado no seguinte código:
MONGODB_URI=mongodb+srv://YOUR_MONGODB_CONNECTION_STRINGDB_CONNECTION=mongodb// Other DB_ values here ...SESSION_DRIVER=mongodbConfigure a autenticação com o Laravel MongoDB.
Depois de instalar e configurar seu aplicativo para funcionar com o MongoDB, configure a autenticação. O Laravel simplifica a implementação de autenticação fornecendo pacotes como Laravel MongoDB, Laravel Fortify e Laravel Jetstream. Este tutorial usa o Laravel Breeze para autenticação.
Instale o Laravel MongoDB usando o Composer:
composer require laravel/breeze --devApós a conclusão da instalação, execute os seguintes comandos:
php artisan key:generate
php artisan breeze:installphp artisan migrate
php artisan db:seednpm installnpm run devIsso solicitará que você escolha sua pilha preferida e pacote de teste . Para este tutorial, selecione a primeira opção, Lâmina com Alpino:
┌ Which Breeze stack would you like to install? ───────────────┐│ > ● Blade with Alpine ││ ○ Livewire (Volt Class API) with Alpine ││ ○ Livewire (Volt Functional API) with Alpine ││ ○ React with Inertia ││ ○ Vue with Inertia ││ ○ API only │└──────────────────────────────────────────────────────────────┘Este comando adiciona visualizações de autenticação, rotas, drivers e outros recursos relacionados ao seu aplicativo.
Configure o modelo de usuário e autenticação para MongoDB.
O Laravel Acesa cria um modelo de usuário padrão para bancos de dados SQL. Você deve atualizá-lo para funcionar com o MongoDB e resolver problemas de compatibilidade de limitação de taxa.
Abra o app/Models/User.php e substitua seu conteúdo pelo seguinte:
namespace App\Models;
use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Notifications\Notifiable;use MongoDB\Laravel\Auth\User as MongoUser;
class User extends MongoUser { use HasFactory, Notifiable;
protected $connection = 'mongodb'; protected $collection = 'users';
/** * The attributes that are mass assignable. * * @var array<int, string> */ protected $fillable = [ 'name', 'email', 'password', ];
/** * The attributes that should be hidden for serialization. * * @var array<int, string> */ protected $hidden = [ 'password', 'remember_token', ];
/** * Get the attributes to cast. * * @return array<string, string> */ protected function casts(): array { return [ 'email_verified_at' => 'datetime', 'password' => 'hashed', ]; }}Sirva o projeto e teste a conexão do MongoDB.
Sirva o projeto usando o servidor integrado do Laravel e confirme se tudo funciona corretamente. No diretório do projeto Laravel, execute o seguinte comando:
php artisan serveO projeto serve a 127.0.0.1:8000. Se a porta 8000 já estiver em uso, o Laravel mudará para uma nova porta disponível, que imprime no terminal.
Para testar o sistema de autenticação, selecione o botão Register em seu aplicativo e crie uma nova conta de usuário. Isso armazena o usuário em seu banco de dados MongoDB e permite que você se conecte com essas credenciais. Para este tutorial, você pode definir o nome de usuário como test@example.com e a senha como password.
Para verificar se o pacote Laravel MongoDB foi configurado corretamente, crie uma rota para ping em seu Cluster MongoDB . Adicione o seguinte a routes/web.php:
Route::get('/ping', function (Request $request) { $connection = DB::connection('mongodb'); try { $connection->command(['ping' => 1]); $msg = 'MongoDB is accessible!'; } catch (\MongoDB\Driver\Exception\ConnectionException $e) { $msg = 'You are not connected to MongoDB. Error: ' . $e->getMessage(); } return ['msg' => $msg];});Visite esta rota no seu navegador. Com a configuração correta, você verá a mensagem "O MongoDB está acessível! " no seu navegador.
Crie o modelo de tarefa e controlador.
Crie o modelo e o controlador para o recurso de agendar tarefas usando o seguinte comando:
php artisan make:model Task --resource --controllerEste comando cria o modelo Task no diretório app/Models e o TaskController no diretório app/Http/Controllers com métodos de recursos.
Crie uma rota para o TaskController navegando até routes/web.php e adicionando o seguinte código:
use App\Http\Controllers\TaskController;
// Other route definitions...
Route::resource('tasks', TaskController::class)->middleware('auth');Configure o modelo de tarefa.
Navegue até app/Models/Task.php e substitua o conteúdo do arquivo pelo seguinte código:
namespace App\Models;
use MongoDB\Laravel\Eloquent\Model;
class Task extends Model { protected $connection = 'mongodb'; protected $table = 'tasks';
protected $fillable = [ 'title', 'description', 'due_date', 'email', 'reminder_time', 'last_notification_date' ];}Este código cria o modelo de tarefa com as seguintes especificações:
A declaração
use MongoDB\Laravel\Eloquent\Modelapós o namespace é específica para os modelos do MongoDB . Ele substitui os recursos Eloquent implementados com SQL usando consultas MongoDB .A propriedade
protected $table = 'tasks'é opcional. Especifica o nome da coleção MongoDB usada para armazenar os documentos deste modelo.A propriedade
protected $fillableespecifica as propriedades atribuíveis em massa.
Dica
Uma das funcionalidades exclusivas do MongoDB é que ele não exige migrações como os bancos de dados relacionais. Você pode adicionar novos campos diretamente aos seus documentos sem atualizar o modelo ou criar migrações. Esta funcionalidade é útil para lidar com dados dinâmicos.
Crie a lógica TaskController.
Navegue até app/Http/Controllers/TaskController.php e atualize o conteúdo com o seguinte código:
namespace App\Http\Controllers;
use App\Models\Task; use Carbon\Carbon; use Illuminate\Http\Request;
class TaskController extends Controller { /** * Displays a listing of the resource. */ public function index() { $tasks = Task::where('email', auth()->user()->email)->get(); return view('tasks.index', compact('tasks')); }
/** * Shows the form for creating a new resource. */ public function create() { return view('tasks.create'); }
/** * Stores a newly created resource in storage. */ public function store(Request $request) { $data = $request->validate([ 'title' => 'required|string|max:255', 'description' => 'nullable|string', 'due_date' => 'required|date', 'reminder_time' => 'required|date', ]);
$data['due_date'] = Carbon::parse($request->due_date); $data['reminder_time'] = Carbon::parse($request->reminder_time); $data['email'] = auth()->user()->email; $data['last_notification_date'] = null;
Task::create($data);
return redirect()->route('tasks.index')->with('success', 'Task created successfully.'); }
/** * Displays the specified resource. */ public function show(string $id) { // }
/** * Shows the form for editing the specified resource. */ public function edit(string $id) { $tasks = Task::where('id', $id)->get(); return view('tasks.edit', ['tasks' => $tasks]); }
/** * Updates the specified resource in storage. */ public function update(Request $request, string $id) { $data = $request->validate([ 'title' => 'required|string|max:255', 'description' => 'nullable|string', 'due_date' => 'required|date', 'reminder_time' => 'required|date', ]);
$task = Task::findOrFail($id);
$data['due_date'] = Carbon::parse($request->due_date)->format('Y-m-d H:i:s'); $data['reminder_time'] = Carbon::parse($request->reminder_time)->format('Y-m-d H:i:s'); $task->update($data);
return redirect()->route('tasks.index')->with('success', 'Task updated successfully.'); }
/** * Removes the specified resource from storage. */ public function destroy(string $id) { $task = Task::findOrFail($id); $task->delete(); return redirect()->route('tasks.index')->with('success', 'Task deleted successfully.'); }}A classe TaskController contém código que lida com as operações CRUD do modelo de tarefa:
O método
index()recupera todas as tarefas pertencentes ao usuário conectado e as envia para o arquivoindex.blade.phppara exibição.O método
create()retorna a visualização do formulário para criar uma nova tarefa.O método
store()valida a entrada, atribui o e-mail do usuário conectado à tarefa e a salva no banco de dados.O método
edit()recupera a tarefa específica a ser editada e a exibe em um formulário de edição.O método
update()salva a tarefa editada na coleção de tarefas do MongoDB .O método
destroy()exclui uma tarefa específica.
Cada operação redireciona de volta para a lista de tarefas com uma mensagem de sucesso para feedback do usuário.
Crie arquivos de visualização para o agendador de tarefas.
No diretório resources/views, crie uma pasta denominada tasks e crie os seguintes arquivos nela:
create.blade.phpedit.blade.phpindex.blade.php
Navegue até resources/views/tasks/create.blade.php e adicione o seguinte conteúdo:
<x-app-layout> <x-slot name="header"> <h2 class="font-semibold text-xl text-gray-800 leading-tight"> {{ __('Tasks') }} </h2> </x-slot>
<div class="py-12"> <div class="max-w-7xl mx-auto sm:px-6 lg:px-8"> <div class="bg-white overflow-hidden shadow-sm sm:rounded-lg"> <div class="container mx-auto p-4"> <h2 class="text-2xl font-bold mb-4">Create New Task</h2> <form action="{{ route('tasks.store') }}" method="POST"> @csrf <div class="mb-4"> <label for="title" class="block text-gray-700">Title:</label> <input type="text" name="title" id="title" required class="border border-gray-300 p-2 w-full" value="{{ old('title') }}"> @error('title') <p class="text-red-500">{{ $message }}</p> @enderror </div> <div class="mb-4"> <label for="description" class="block text-gray-700">Description:</label> <textarea name="description" id="description" class="border border-gray-300 p-2 w-full">{{ old('description') }}</textarea> </div> <div class="mb-4"> <label for="due_date" class="block text-gray-700">Due Date:</label> <input type="date" name="due_date" id="due_date" required class="border border-gray-300 p-2 w-full" value="{{ old('due_date') }}"> @error('due_date') <p class="text-red-500">{{ $message }}</p> @enderror </div> <div class="mb-4"> <label for="reminder_time" class="block text-gray-700">Reminder Time:</label> <input type="datetime-local" name="reminder_time" id="reminder_time" class="border border-gray-300 p-2 w-full" value="{{ old('reminder_time') }}"> </div> <button type="submit" class="bg-green-600 text-white p-2 border rounded"> Create Task </button> </form> </div> </div> </div> </div></x-app-layout>O formulário contém entradas de texto para title e description e entradas de data e hora para due date e reminder time.
Navegue até resources/views/tasks/edit.blade.php e adicione o seguinte conteúdo:
<x-app-layout> <x-slot name="header"> <h2 class="font-semibold text-xl text-gray-800 leading-tight"> {{ __('Edit Task') }} </h2> </x-slot>
<div class="py-12"> <div class="max-w-7xl mx-auto sm:px-6 lg:px-8"> <div class="bg-white overflow-hidden shadow-sm sm:rounded-lg"> <div class="p-6 text-gray-900"> @foreach($tasks as $task) <form action="{{ route('tasks.update', $task->id) }}" method="POST"> @csrf @method('PUT') <div class="mb-4"> <label for="title" class="block text-gray-700">Title:</label> <input type="text" name="title" id="title" required class="border border-gray-300 p-2 w-full" value="{{ old('title', $task->title) }}"> @error('title') <p class="text-red-500">{{ $message }}</p> @enderror </div> <div class="mb-4"> <label for="description" class="block text-gray-700">Description:</label> <textarea name="description" id="description" class="border border-gray-300 p-2 w-full">{{ old('description', $task->description) }}</textarea> </div> <div class="mb-4"> <label for="due_date" class="block text-gray-700">Due Date:</label> <input type="date" name="due_date" id="due_date" required class="border border-gray-300 p-2 w-full" value="{{ old('due_date', $task->due_date) }}"> @error('due_date') <p class="text-red-500">{{ $message }}</p> @enderror </div> <div class="mb-4"> <label for="reminder_time" class="block text-gray-700">Reminder Time:</label> <input type="datetime-local" name="reminder_time" id="reminder_time" class="border border-gray-300 p-2 w-full" value="{{ old('reminder_time', $task->reminder_time) }}"> </div> <button type="submit" class="bg-blue-500 text-white p-2 rounded"> Update Task </button> </form> @endforeach </div> </div> </div> </div></x-app-layout>O formulário de edição contém os mesmos campos de entrada que o formulário de criação e é carregado com os dados da tarefa que está sendo editada.
Navegue até resources/views/tasks/index.blade.php e adicione o seguinte conteúdo:
<x-app-layout> <x-slot name="header"> <h2 class="font-semibold text-xl text-gray-800 leading-tight"> {{ __('Tasks') }} </h2> </x-slot>
<div class="py-12"> <div class="max-w-7xl mx-auto sm:px-6 lg:px-8"> <div class="bg-white overflow-hidden shadow-sm sm:rounded-lg"> <div class="p-6 text-gray-900"> <div class="mb-2"> <a href="{{ route('tasks.create') }}" class="p-2 border mb-4"> Create New Task </a> </div> <ul class="mt-4"> @foreach ($tasks as $task) <div class="mt-2"> <hr> </div> <li> <h1 class="text-2xl"> <strong>{{ $task->title }}</strong> - Due: {{ $task->due_date }} </h1> <p class="text-gray-600"> {{ $task->description }} </p> <div class="flex gap-2 mt-4"> <div class="p-2 text-white bg-gray-700"> <a href="{{ route('tasks.edit', $task->id) }}"> Edit </a> </div> <div class="p-2 text-white bg-red-700 rounded"> <form action="{{ route('tasks.destroy', $task->id) }}" method="POST" style="display:inline;"> @csrf @method('DELETE') <button type="submit">Delete</button> </form> </div> </div> </li> @endforeach </ul> </div> </div> </div> </div></x-app-layout>Essa visualização inclui um link para o formulário de criação e percorre todas as tarefas para exibir aquelas pertencentes ao usuário autenticado.
Adiciona link de navegação para tarefas.
Adicione um link para o recurso de tarefa a partir da navegação do seu aplicativo. Go para resources/views/layouts/navigation.blade.php e adicione o seguinte código após o link de navegação do dashboard:
// ...existing code ... <div class="hidden space-x-8 sm:-my-px sm:ms-10 sm:flex"> <x-nav-link :href="route('tasks.index')" :active="request()->routeIs('tasks.index')"> {{ __('Tasks') }} </x-nav-link></div>Neste ponto, você pode testar as operações CRUD do seu sistema de gerenciamento de tarefas. Certifique-se de que tudo funcione corretamente antes de passar para a próxima seção.
Crie um comando Atlasan personalizado para enviar avisos.
Para implementar o sistema de lembretes para tarefas vencidas, crie um comando Artisan personalizado para enviar lembretes por e-mail e registre o comando para agendar automaticamente.
Para criar um comando Atlas personalizado, execute o seguinte código no seu terminal:
php artisan make:command SendTaskRemindersApós criar o comando, atualize o conteúdo do arquivo app/Console/Commands/SendTaskReminders.php com o seguinte código:
namespace App\Console\Commands;
use App\Models\Task; use Carbon\Carbon; use Illuminate\Console\Command;use Illuminate\Support\Facades\Mail;
class SendTaskReminders extends Command { /** * The name and signature of the console command. * * @var string */ protected $signature = 'app:send-task-reminders';
/** * The console command description. * * @var string */ protected $description = 'Command description';
/** * Execute the console command. */ public function handle() { $now = Carbon::now(); $upcomingTasks = Task::where('last_notification_date', null)->get();
$upcomingTasks = Task::where('last_notification_date', null) ->where('reminder_time', '>=', $now->clone()->subMinutes(10)) ->get();
foreach ($upcomingTasks as $task) { $emailBody = <<<EOFHello,
This is a reminder for your task:
Title: {$task->title}Description: {$task->description}Due Date: {$task->due_date}
Please make sure to complete it on time!
Regards,Your Task Reminder AppEOF;
Mail::raw($emailBody, function ($message) use ($task) { $message->to($task->email) ->subject("Task Reminder: {$task->title}"); });
$task->last_notification_date = $now; $task->save(); $this->info("Reminder email sent for task: {$task->title}"); }
return self::SUCCESS; }}A lógica principal do comando Personalizado do Mestre está escrita no método handle(). O código obtém o carimbo de data/hora atual usando Carbon::now().
Em seguida, ele consulta o banco de dados para obter todas as tarefas em que reminder_time é menor ou igual ao tempo atual e onde reminder_time é maior ou igual a 10 minutos antes do tempo atual. No MongoDB, todas as datas são armazenadas em UTC. Mesmo que seu servidor use um zona horário diferente , você não precisará alterar o zona horário .
A query busca todas as tarefas vencidas nos próximos 10 minutos. O código percorre os resultados e envia alertas para os e-mails do usuário de tarefas que serão vencidas nos próximos 10 minutos.
Observação
Para que o agendador de tarefas funcione corretamente, você deve configurar seu aplicativo para enviar e-mails. Mailtrap.io é uma ferramenta útil para testar o envio de e-mails. Para aprender mais, consulte Enviar e-mail no Laravel.
Agende notificações para avisos de tarefas.
Para concluir a configuração, agende o comando Array criado na etapa anterior para executar a cada minuto. Esta abordagem executa automaticamente php artisan app:send-task-reminders a cada minuto.
Navegue até routes/console.php e adicione o seguinte código:
// ...existing code ...Schedule::command('app:send-task-reminders')->everyMinute();Para testar se isso funciona, execute o seguinte comando:
php artisan schedule:runEm um servidor de produção, você deve configurar um tarefa cron para executar o comando php artisan schedule:run em intervalos regulares.
Em um servidor baseado em Linux ou Unix, você pode abrir seu arquivo de configuração do cron usando o seguinte comando:
crontab -eAdicione o seguinte código à aba de configuração do cron:
* * * * * /usr/bin/php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1Substitua /usr/bin/php pelo caminho para o binário do PHP e /path-to-your-project pelo caminho completo para o projeto Laravel no servidor. Salve e saia do arquivo.
Para verificar se a tarefa cron está configurada corretamente, execute o seguinte comando:
crontab -lResumo
Agora você tem um aplicativo agendador de tarefas que usa Laravel e MongoDB. Este tutorial demonstra como realizar as seguintes ações:
Configurar um projeto Laravel para trabalhar com MongoDB
Implemente recursos CRUD para o agendador de tarefas
Crie um comando personalizado do Laravel Atlasan para o sistema de alerta
Agende uma tarefa para executar o comando Mestre em intervalos
Configurar a tarefa cron em um servidor baseado em Linux
Próximos passos
Para saber mais sobre os conceitos abordados neste tutorial, consulte os seguintes recursos:
Interação com dados para exemplos de código de operações comuns
Modele seus dados para trabalhar com modelos Eloquent