Как реализовать аутентификацию в Next.js 14 с помощью NextAuth.js, Shadcn/ui, response-hook-form и Zod

Полное руководство: учетные данные (электронная почта и пароль)

Обеспечение безопасности и конфиденциальности пользователей сейчас важнее, чем когда-либо. Веб-аутентификация играет решающую роль в этом аспекте, выступая в качестве первой линии защиты информации и данных пользователей.

Сегодня у нас есть такие инструменты, как NextAuth.js, которые значительно облегчают нашу работу, позволяя нам легко реализовывать различные типы аутентификации в наших приложениях Next.js.

В этой серии руководств мы собираемся создать полноценную систему аутентификации в Next.js 14, начиная с основ: аутентификации с помощью электронной почты и пароля.

Что такое NextAuth.js (Auth.js)?

В экосистеме JavaScript и, в частности, в приложениях, разработанных с помощью Next.js, одной из наиболее известных библиотек для обработки аутентификации является NextAuth.js.

Этот инструмент предлагает простое и легкое в реализации решение для добавления аутентификации в наши приложения. Самое лучшее — это его гибкость; он позволяет интегрировать различных поставщиков аутентификации, таких как Google, Facebook и Twitter, в дополнение к аутентификации на основе учетных данных, такой как классическая электронная почта и пароль.

Реализация аутентификации учетных данных

Аутентификация по учетным данным особенно полезна в приложениях, где вам необходим полный контроль над процессом аутентификации и хранением учетных данных пользователя или когда вы не хотите полагаться на внешних поставщиков аутентификации.

Настройка

1. Создайте новый проект Next.js с помощью следующей команды и выполните указанные шаги. Мы будем использовать TypeScript и папку src/ .

 npx create-next-app@latest

2. Установите зависимости, необходимые в проекте. На этот раз мы будем использовать pnpm ; вы можете использовать менеджер пакетов по вашему выбору.

 pnpm install next-auth prisma react-hook-form zod, bcrypt

Для пользовательского интерфейса мы будем использовать Shadcn/ui.

 pnpm dlx shadcn-ui@latest init

• призма : набор инструментов для работы с базами данных с открытым исходным кодом. Мы будем использовать его для хранения учетных данных пользователя.

• следующая аутентификация : Аутентификация для Next.js.

• форма реакции-крючка : библиотека, которая помогает проверять формы в React.

• зод : средство проверки данных.

• bcrypt : для хеширования паролей.

• Shadcn / пользовательский интерфейс : коллекция повторно используемых компонентов.

  
  

3. Создайте следующую структуру проекта:

 ... ├── prisma/ ... ├── src/ │ ├── actions/ │ │ └── auth-actions.tsx │ ├── app/ │ │ ├── api/auth/[...nextauth] │ │ │ └── route.ts │ │ ├── auth/ │ │ │ ├── signin │ │ │ │ └── page.tsx │ │ │ └── signup │ │ │ └── page.tsx │ │ │ ... │ ├── components/ │ │ ├── auth/ │ │ │ ├── auth-buttons.tsx │ │ │ ├── signin-form.tsx │ │ │ ├── signup-form.tsx │ │ │ └── user-nav.ts │ │ ├── ui/ │ │ │ ... │ │ ├── auth-provider.tsx │ │ ├── icons.tsx │ │ └── theme-provider.tsx │ ├── lib/ │ │ ├── prisma.ts │ │ ├── types.d.ts │ │ └── utils.ts │ ... ...

Настройка Призмы

Мы будем использовать Prisma для хранения и извлечения пользователей из базы данных. Prisma позволяет интегрировать различные типы баз данных, поэтому вы можете использовать любую необходимую вам базу данных, мы будем использовать SQLite.

1. Инициализация Призмы .

   
   

 npx prisma init --datasource-provider sqlite

При этом создается папка призмы с ее схемами.

2. Создание моделей.

Для создания моделей мы будем использовать модели, предоставленные @auth/prisma-adapter , и немного настроим их следующим образом:

prisma/schema.prisma :

 generator client { provider = "prisma-client-js" output = "../../node_modules/.prisma/client" } datasource db { provider = "sqlite" url = env("DATABASE_URL") } ... model User { id String @id @default(cuid()) username String password String email String @unique emailVerified DateTime? phone String? image String? } ...

3. Создание первого миграция .

 npx prisma migrate dev --name first-migration

С помощью этой команды в папке Prisma было создано больше файлов, а база данных синхронизирована с моделями.

4. Клиент Призма

Наконец, мы создаем клиент Prisma.

lib/prisma.ts :

 import { PrismaClient } from "@prisma/client"; const globalForPrisma = global as unknown as { prisma: PrismaClient; }; export const prisma = globalForPrisma.prisma || new PrismaClient(); if (process.env.NODE_ENV !== "production") globalForPrisma.prisma = prisma; export default prisma;

Настройка NextAuth.js

1. Создание переменных env .

 # Secret key for NextAuth.js, used for encryption and session security. It should be a long, # random string unique to your application. NEXTAUTH_SECRET=XXX3B2CC28F123456C6934531CXXXXX # Base URL for your Next.js app, used by NextAuth.js for redirects and callbacks. NEXTAUTH_URL=http://localhost:3000/

2. Создание маршрута авторизации.

Этот путь позволяет обрабатывать все запросы аутентификации (например, вход в систему, выход из системы и обратные вызовы поставщика) на одной конечной точке.

src/app/api/auth/[...nextauth]

3. Создание провайдеров.

 ... // Imports the Prisma User type for typing. import { User } from '@prisma/client' // Configuration of authentication options for NextAuth. export const authOptions: AuthOptions = { ... // Defines authentication providers, in this case, only credentials. providers: [ CredentialsProvider({ name: 'Credentials', // Defines the required fields for authentication. credentials: { email: { label: 'Email', type: 'text' }, password: { label: 'Password', type: 'password' }, }, // Function to authenticate the user with the provided credentials. async authorize(credentials) { // Searches for the user in the database by email. const user = await prisma.user.findUnique({ where: { email: credentials?.email, }, }) // Checks if the user exists and if the password is correct. if (!user) throw new Error('User name or password is not correct') if (!credentials?.password) throw new Error('Please Provide Your Password') const isPasswordCorrect = await bcrypt.compare(credentials.password, user.password) if (!isPasswordCorrect) throw new Error('User name or password is not correct') // Returns the user without including the password. const { password, ...userWithoutPass } = user return userWithoutPass }, }), ], } // Exports the configured NextAuth handler to handle GET and POST requests. const handler = NextAuth(authOptions) export { handler as GET, handler as POST }

4. Создание поставщика аутентификации.

src/components/auth-provider.tsx :

 'use client' import { SessionProvider } from 'next-auth/react' export default function AuthProvider({ children }: { children: React.ReactNode }) { return <SessionProvider>{children}</SessionProvider> }

Этот компонент действует как поставщик сеансов для приложений Next.js, которые используют NextAuth для аутентификации.

Обертывание компонентов или страниц в этот поставщик предоставляет им доступ к контексту сеанса, позволяя дочерним компонентам использовать перехватчики и функции NextAuth, такие как useSession , для доступа или изменения состояния текущего сеанса пользователя.

src/app/layout.tsx :

 /* All imports */ export default function RootLayout({ children }: { children: React.ReactNode }) { return ( <html lang='en' suppressHydrationWarning > <body className={`${inter.className} relative`}> <AuthProvider> <main>{children}</main> </AuthProvider> </body> </html> ) }

Настройка пользовательского интерфейса с помощью Shadcn/ui

1. Установка shadcn/ui в соответствии с инструкциями документация (шаг 2) .

 Would you like to use TypeScript (recommended)? yes Which style would you like to use? › Default Which color would you like to use as base color? › Slate Where is your global CSS file? › src/app/globals.css Do you want to use CSS variables for colors? › yes Are you using a custom tailwind prefix eg. tw-? Leave blank Where is your tailwind.config.js located? › tailwind.config.js Configure the import alias for components: › @/components Configure the import alias for utils: › @/lib/utils Are you using React Server Components? › yes

Вы можете использовать тему по вашему выбору.

2. Реализация Темный режим

src/app/layout.tsx :

 /* All imports */ export default function RootLayout({ children }: { children: React.ReactNode }) { return ( <html lang='en' suppressHydrationWarning > <body className={`${inter.className} relative`}> <AuthProvider> <ThemeProvider attribute='class' defaultTheme='dark' enableSystem disableTransitionOnChange > <main>{children}</main> <Toaster /> </ThemeProvider> </AuthProvider> </body> </html> ) }

2. Установка следующих компонентов shadcn/ui:

 pnpm dlx shadcn-ui@latest add avatar button dropdown-menu form input label tabs toast

Создание компонентов аутентификации

src/components/auth-buttons.tsx :

 'use client' import Link from 'next/link' import { signIn, useSession } from 'next-auth/react' import { Button } from '../ui/button' import { UserNav } from './user-nav' export default function AuthButtons() { // Use the useSession hook to access session data const { data: session } = useSession() return ( <div className='flex justify-end gap-4'> {session && session.user ? ( <UserNav user={session.user} /> ) : ( <> <Button size={'sm'} variant={'secondary'} onClick={() => signIn()} > Sign In </Button> <Button size={'sm'} asChild className='text-foreground' > <Link href='/auth/signup'>Sign Up</Link> </Button> </> )} </div> ) }

Этот компонент динамически отображает параметры аутентификации в зависимости от состояния сеанса пользователя. Если пользователь вошел в систему, отображается специфичная для пользователя навигация. В противном случае он предлагает кнопки для входа или регистрации, используя возможности маршрутизации Next.js и аутентификации NextAuth для удобства пользователя.

Измените домашнюю страницу и добавьте кнопки авторизации. Вот как это выглядит:

src/components/auth/signup-form.tsx :

 'use client' /* all imports */ // Function to register a new user import { registerUser } from '@/actions/auth-actions' // Define the validation schema for the signup form using Zod const formSchema = z .object({ username: z .string({ required_error: 'Username is required', }) .min(2, 'User name must have at least 2 characters') .max(12, 'Username must be up to 12 characters') .regex(new RegExp('^[a-zA-Z0-9]+$'), 'No special characters allowed!'), email: z.string({ required_error: 'Email is required' }).email('Please enter a valid email address'), password: z .string({ required_error: 'Password is required' }) .min(6, 'Password must have at least 6 characters') .max(20, 'Password must be up to 20 characters'), confirmPassword: z .string({ required_error: 'Confirm your password is required' }) .min(6, 'Password must have at least 6 characters') .max(20, 'Password must be up to 20 characters'), }) .refine(values => values.password === values.confirmPassword, { message: "Password and Confirm Password doesn't match!", path: ['confirmPassword'], }) // Type inference for form inputs based on the Zod schema type InputType = z.infer<typeof formSchema> export function SignUpForm() { const [isLoading, setIsLoading] = useState(false) const { toast } = useToast() // Hook to show toast notifications // Initialize form handling with React Hook Form and Zod for validation const form = useForm<InputType>({ resolver: zodResolver(formSchema), }) // Handles form submission async function onSubmit(values: InputType) { try { setIsLoading(true) const { confirmPassword, ...user } = values // Exclude confirmPassword from data to be sent const response = await registerUser(user) // Register the user if ('error' in response) { toast({ title: 'Something went wrong!', description: response.error, variant: 'success', }) } else { toast({ title: 'Account Created!', description: 'Your account has been created successfully! You can now login.', }) } } catch (error) { console.error(error) toast({ title: 'Something went wrong!', description: "We couldn't create your account. Please try again later!", variant: 'destructive', }) } finally { setIsLoading(false) } } return ( <Form {...form}> <form onSubmit={form.handleSubmit(onSubmit)}> <div className='grid gap-2'> // Each FormField validates and displays an input <FormField control={form.control} name='username' render={({ field }) => ( <FormItem> <FormControl> <div className='flex items-center gap-2'> <Icons.user className={`${form.formState.errors.username ? 'text-destructive' : 'text-muted-foreground'} `} /> <Input placeholder='Your Username' className={`${form.formState.errors.username && 'border-destructive bg-destructive/30'}`} {...field} /> </div> </FormControl> <FormMessage /> </FormItem> )} /> // Repeated structure for email, password, and confirmPassword with respective validations and icons <Button className='text-foreground mt-4' disabled={isLoading} // Disable button during form submission > {isLoading && <Icons.spinner className='mr-2 h-4 w-4 animate-spin' />} // Show loading icon if isLoading is true Sign Up </Button> </div> </form> </Form> ) }

Этот компонент инкапсулирует форму регистрации пользователя, используя форму реагирования для управления состоянием формы и Zod для проверки схемы.

Хотя это не руководство по этим технологиям, мы используем только их основы. Если у вас есть дополнительные вопросы, вы можете обратиться к их документации.

Я добавил на страницу еще несколько стилей, и она выглядит так:

src/actions/auth-action/ts :

 'use server' /* all imports */ export async function registerUser(user: Omit<User, 'id' | 'phone' | 'emailVerified' | 'image'>) { try { // Attempt to create a new user record in the database const result = await prisma.user.create({ data: { ...user, // Hash the password before storing it password: await bcrypt.hash(user.password, 10), }, }) return result } catch (error) { console.log(error) // Handle known request errors from Prisma if (error instanceof Prisma.PrismaClientKnownRequestError) { // Check for unique constraint failure (eg, email already exists) if (error.code === 'P2002') { return { error: 'Email already exists.' } } } // Return a generic error message for any other errors return { error: 'An unexpected error occurred.' } } }

Функция registerUser предназначена для безопасной регистрации нового пользователя путем создания записи в базе данных с предоставленной информацией о пользователе, исключая такие поля, как id , phone , emailVerified и image .

Он использует bcrypt для хеширования пароля пользователя для безопасного хранения.

Чтобы протестировать нашу регистрацию и убедиться, что пользователь регистрируется правильно, нам нужно добавить несколько обратных вызовов; это функции, которые позволяют вам настроить поведение аутентификации и управления сеансами.

src/app/api/auth/[...nextauth] :

 ... export const authOptions: AuthOptions = { // Define custom pages for authentication flow pages: { signIn: '/auth/signin', // Custom sign-in page }, // Configure session management to use JSON Web Tokens (JWT) session: { strategy: 'jwt', }, // JWT configuration, including secret for token signing jwt: { secret: process.env.NEXTAUTH_SECRET, // Secret used to sign the JWT, stored in environment variables }, ... // Callbacks for customizing JWT and session behaviors callbacks: { // Callback to modify the JWT content. Adds user information if available. async jwt({ token, user }) { if (user) token.user = user as User // Cast user object to User type and assign to token return token }, // Callback to modify session content. Adds user information to the session. async session({ token, session }) { session.user = token.user // Assign user information from token to session return session }, }, } ...

Обратный вызов jwt : этот обратный вызов выполняется всякий раз, когда веб-токен JSON (JWT) создается или обновляется в течение жизненного цикла аутентификации. Это позволяет вам изменять содержимое токена до того, как он будет подписан и отправлен клиенту или сохранен на сервере.

Это полезно для добавления в токен дополнительной информации, которая может иметь отношение к логике вашего приложения.

session обратного вызова: этот обратный вызов вызывается каждый раз, когда считываются данные сеанса, например, во время рендеринга на стороне сервера или в защищенных запросах API. Это позволяет изменять данные сеанса перед их отправкой клиенту.

Это особенно полезно для добавления или изменения данных сеанса на основе информации, хранящейся в JWT, или других критериев.

Наконец, нам нужно расширить определения типов Session NextAuth и JWT , включив в них дополнительную информацию о пользователе.

src/lib/types.d.ts :

 import { User } from '@prisma/client' declare module 'next-auth' { interface Session { user: User } } declare module 'next-auth/jwt' { interface JWT { user: User } }

Теперь, если мы заполним форму и отправим ее, мы сможем увидеть тост за успех. Чтобы убедиться, что пользователь был сохранен в базе данных, мы можем увидеть графически таблицы, созданные Prisma, с помощью следующей команды:

 nxp prisma studio

Нам будет доступен следующий маршрут http://localhost:5555

src/components/auth/user-nav.tsx :

 /* all imports */ interface Props { user: User // Expect a user object of type User from Prisma client } export function UserNav({ user }: Props) { return ( <DropdownMenu> <DropdownMenuTrigger asChild> <Button variant='ghost' className='relative h-8 w-8 rounded-full' > <Avatar className='h-9 w-9'> <AvatarImage src='/img/avatars/01.png' alt='' /> <AvatarFallback>UU</AvatarFallback> </Avatar> </Button> </DropdownMenuTrigger> <DropdownMenuContent className='w-56' align='end' forceMount > <DropdownMenuLabel className='font-normal'> <div className='flex flex-col space-y-1'> <p className='text-sm font-medium leading-none'>{user.username}</p> <p className='text-xs leading-none text-muted-foreground'>{user.email}</p> </div> </DropdownMenuLabel> <DropdownMenuSeparator /> <DropdownMenuItem> <Link href={'/api/auth/signout'} // Link to the signout API route className='w-full' > Sign Out </Link> </DropdownMenuItem> </DropdownMenuContent> </DropdownMenu> ) } 

src/components/auth/signin-form.tsx :

 /* all imports */ // Schema definition for form validation using Zod const formSchema = z.object({ email: z.string({ required_error: 'Please enter your email' }).email('Please enter a valid email address'), password: z.string({ required_error: 'Please enter your password', }), }) // Type inference for form inputs based on the Zod schema type InputType = z.infer<typeof formSchema> // Props definition, optionally including a callback URL interface Props { callbackUrl?: string } export function SignInForm({ callbackUrl }: Props) { const [isLoading, setIsLoading] = useState(false) const { toast } = useToast() const router = useRouter() // Hook to control routing const form = useForm<InputType>({ resolver: zodResolver(formSchema), // Set up Zod as the form validation resolver }) // Function to handle form submission async function onSubmit(values: InputType) { try { setIsLoading(true) // Attempt to sign in using the 'credentials' provider const response = await signIn('credentials', { redirect: false, // Prevent automatic redirection email: values.email, password: values.password, }) // Handle unsuccessful sign in attempts if (!response?.ok) { toast({ title: 'Something went wrong!', description: response?.error, variant: 'destructive', }) return } toast({ title: 'Welcome back! ', description: 'Redirecting you to your dashboard!', }) router.push(callbackUrl ? callbackUrl : '/') // Redirect to the callback URL or home page } catch (error) { toast({ title: 'Something went wrong!', description: "We couldn't create your account. Please try again later!", variant: 'destructive', }) } finally { setIsLoading(false) } } return ( <Form {...form}> <form onSubmit={form.handleSubmit(onSubmit)}> <div className='grid gap-2'> <div className='grid gap-1'> <FormField control={form.control} name='email' render={({ field }) => ( <FormItem> <FormControl> <div className='flex items-center gap-2'> <Icons.email className={`${form.formState.errors.email ? 'text-destructive' : 'text-muted-foreground'} `}/> <Input type='email' placeholder='Your Email' className={`${form.formState.errors.email && 'border-destructive bg-destructive/30'}`} {...field} /> </div> </FormControl> <FormMessage /> </FormItem> )} /> {/* Password field */} {/* Similar structure to email field, customized for password input */} </div> <Button className='text-foreground mt-4' disabled={isLoading} // Disable button while loading > {isLoading && <Icons.spinner className='mr-2 h-4 w-4 animate-spin' />} // Show loading spinner when processing Sign In </Button> </div> </form> </Form> ) } 

🎉 Готово!

Мы завершили реализацию базовой аутентификации с помощью NextAuth.js. Для создания полноценной системы аутентификации еще многое предстоит сделать, и мы рассмотрим их в следующих руководствах.

🔗 Репо здесь

Заключение

Таким образом, мы изучили, как реализовать и настроить систему аутентификации в Next.js с использованием NextAuth, как расширить сеансы и JWT для улучшения управления пользователями, а также как обрабатывать формы с эффективной проверкой с использованием React-Hook-Form и Zod.

Хотите связаться с Автором?

Люблю общаться с друзьями по всему миру на 𝕏 .

Также опубликовано здесь