使用Go語(yǔ)言封裝實(shí)現(xiàn)郵件發(fā)送功能
在現(xiàn)代 Web 開(kāi)發(fā)中,郵件發(fā)送功能是一個(gè)常見(jiàn)的需求,特別是在用戶注冊(cè)、密碼重置、通知等場(chǎng)景中,往往需要通過(guò)郵件發(fā)送驗(yàn)證碼或其他信息。本文將介紹如何在 Go 語(yǔ)言中封裝一個(gè)通用的郵件發(fā)送包,支持驗(yàn)證碼發(fā)送和通用郵件發(fā)送。
目標(biāo)
封裝一個(gè)郵件發(fā)送的包
支持 SMTP 協(xié)議發(fā)送郵件
提供發(fā)送驗(yàn)證碼和普通郵件的功能
通過(guò)結(jié)構(gòu)體和方法實(shí)現(xiàn)面向?qū)ο蟮脑O(shè)計(jì)
完善的單元測(cè)試,確保代碼健壯性
依賴包
在開(kāi)始之前,需要引入以下依賴包:
go get github.com/jordan-wright/email go get go.uber.org/zap go get github.com/stretchr/testify
- github.com/jordan-wright/email:一個(gè)常用的 Go 語(yǔ)言郵件發(fā)送庫(kù),簡(jiǎn)化 SMTP 發(fā)送流程。
- go.uber.org/zap:Uber 開(kāi)發(fā)的高效日志庫(kù),用于記錄日志。
- github.com/stretchr/testify:Go 的單元測(cè)試庫(kù)。
項(xiàng)目結(jié)構(gòu)
│ ├── email.go
│ └── email_test.go
├── model
│ └── cache.go
├── pkg
│ └── logger.go
├── go.mod
├── go.sum
└── main.go
代碼實(shí)現(xiàn)
email/email.go
創(chuàng)建 email/email.go 文件,封裝郵件發(fā)送功能。
package email
import (
"fmt"
"gin-mall/model"
"gin-mall/pkg/logger"
"net/smtp"
"time"
"github.com/jordan-wright/email"
"go.uber.org/zap"
)
// Email 郵件
type Email struct {
config Config // 郵件配置
From string // 發(fā)件人
To []string // 收件人
Subject string // 主題
Body string // 內(nèi)容
}
// Config 郵件配置
type Config struct {
SMTPServer string // SMTP服務(wù)器
SMTPPort int // SMTP端口
Username string // 用戶名
Password string // 密碼
}
// NewEmail 創(chuàng)建Email實(shí)例
func NewEmail(config Config) *Email {
e := &Email{config: config}
e.From = config.Username
return e
}
// SetFrom 設(shè)置發(fā)件人
func (e *Email) SetFrom(from string) {
e.From = from
}
// SetTo 設(shè)置收件人
func (e *Email) SetTo(to []string) {
e.To = to
}
// AppendTo 添加收件人
func (e *Email) AppendTo(to string) {
e.To = append(e.To, to)
}
// SetSubject 設(shè)置郵件主題
func (e *Email) SetSubject(subject string) {
e.Subject = subject
}
// SetBody 設(shè)置郵件內(nèi)容
func (e *Email) SetBody(body string) {
e.Body = body
}
// Send 發(fā)送郵件
func (e *Email) Send() error {
auth := smtp.PlainAuth("", e.config.Username, e.config.Password, e.config.SMTPServer)
host := fmt.Sprintf("%s:%d", e.config.SMTPServer, e.config.SMTPPort)
eClient := email.NewEmail()
eClient.From = e.From
eClient.To = e.To
eClient.Subject = e.Subject
eClient.Text = []byte(e.Body)
err := eClient.Send(host, auth)
if err != nil {
return err
}
return nil
}
// SendVerifyCode 發(fā)送驗(yàn)證碼
func (e *Email) SendVerifyCode(receiver, code, key string) error {
// 保存驗(yàn)證碼到緩存
err := model.CacheDb.Set(key, code, 5*time.Minute)
if err != nil {
logger.Error("設(shè)置緩存失敗", zap.Error(err))
return err
}
// 發(fā)送郵件
msg := fmt.Sprintf("【XXX】您的驗(yàn)證碼是: %s, 請(qǐng)?jiān)?分鐘內(nèi)完成驗(yàn)證.", code)
e.AppendTo(receiver)
e.SetSubject("GinMall 驗(yàn)證碼")
e.SetBody(msg)
return e.Send()
}
主要方法說(shuō)明
| 方法名 | 功能 | 說(shuō)明 |
|---|---|---|
| NewEmail | 創(chuàng)建新的郵件實(shí)例 | 通過(guò)傳入 SMTP 配置,創(chuàng)建 Email 結(jié)構(gòu)體 |
| SetFrom | 設(shè)置發(fā)件人 | 可自定義發(fā)件人 |
| SetTo | 設(shè)置收件人 | 直接設(shè)置收件人數(shù)組 |
| AppendTo | 添加收件人 | 動(dòng)態(tài)添加收件人 |
| SetSubject | 設(shè)置主題 | 設(shè)置郵件的標(biāo)題 |
| SetBody | 設(shè)置內(nèi)容 | 設(shè)置郵件的內(nèi)容 |
| Send | 發(fā)送郵件 | 通過(guò) SMTP 協(xié)議發(fā)送郵件 |
| SendVerifyCode | 發(fā)送驗(yàn)證碼 | 生成并發(fā)送驗(yàn)證碼 |
單元測(cè)試
email/email_test.go
創(chuàng)建 email/email_test.go,對(duì)郵件發(fā)送功能進(jìn)行測(cè)試。
package email
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestSendEmail(t *testing.T) {
config := Config{
SMTPServer: "smtp.163.com",
SMTPPort: 25,
Username: "your-email@163.com",
Password: "your-password",
}
email := NewEmail(config)
assert.NotNil(t, email)
email.SetFrom(config.Username)
email.AppendTo("receiver@example.com")
email.SetSubject("Test Email")
email.SetBody("This is a test email.")
err := email.Send()
assert.Nil(t, err)
t.Logf("Email sent successfully")
}
使用示例
在 main.go 文件中直接調(diào)用封裝好的方法來(lái)發(fā)送郵件:
package main
import (
"log"
"gin-mall/email"
)
func main() {
config := email.Config{
SMTPServer: "smtp.163.com",
SMTPPort: 25,
Username: "your-email@163.com",
Password: "your-password",
}
email := email.NewEmail(config)
email.SetFrom(config.Username)
email.AppendTo("receiver@example.com")
email.SetSubject("Welcome to GinMall")
email.SetBody("Thank you for signing up to GinMall!")
err := email.Send()
if err != nil {
log.Fatalf("Failed to send email: %v", err)
} else {
log.Println("Email sent successfully")
}
}
代碼亮點(diǎn)
? 面向?qū)ο笤O(shè)計(jì),封裝良好
? 使用 go.uber.org/zap 記錄日志
? 使用 github.com/jordan-wright/email 簡(jiǎn)化 SMTP 發(fā)送
? 使用 github.com/stretchr/testify 進(jìn)行單元測(cè)試
改進(jìn)方向
支持 HTML 格式的郵件內(nèi)容
支持添加附件
通過(guò)配置文件設(shè)置郵件參數(shù)
添加郵件發(fā)送失敗的重試機(jī)制
總結(jié)
通過(guò)封裝 github.com/jordan-wright/email,我們可以快速實(shí)現(xiàn)郵件發(fā)送功能。封裝良好的結(jié)構(gòu)體和方法,使代碼更易于擴(kuò)展和復(fù)用。希
到此這篇關(guān)于使用Go語(yǔ)言封裝實(shí)現(xiàn)郵件發(fā)送功能的文章就介紹到這了,更多相關(guān)Go郵件發(fā)送內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Go項(xiàng)目編寫Makefile規(guī)則文件概述
這篇文章主要為大家介紹了Go項(xiàng)目編寫Makefile文件規(guī)則概述,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步早日升職加薪2022-04-04
Golang高性能持久化解決方案BoltDB數(shù)據(jù)庫(kù)介紹
這篇文章主要為大家介紹了Golang高性能持久化解決方案BoltDB數(shù)據(jù)庫(kù)介紹,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步2021-11-11
GO語(yǔ)言實(shí)現(xiàn)列出目錄和遍歷目錄的方法
這篇文章主要介紹了GO語(yǔ)言實(shí)現(xiàn)列出目錄和遍歷目錄的方法,涉及ioutil.ReadDir()與filepath.Walk()的應(yīng)用,是非常實(shí)用的技巧,需要的朋友可以參考下2014-12-12
golang獲取變量或?qū)ο箢愋偷膸追N方式總結(jié)
在golang中并沒(méi)有提供內(nèi)置函數(shù)來(lái)獲取變量的類型,但是通過(guò)一定的方式也可以獲取,下面這篇文章主要給大家介紹了關(guān)于golang獲取變量或?qū)ο箢愋偷膸追N方式,需要的朋友可以參考下2022-12-12
go語(yǔ)言之?dāng)?shù)組和切片使用及說(shuō)明
Go語(yǔ)言中數(shù)組是固定大小的值類型,切片是動(dòng)態(tài)引用類型,包含指針、長(zhǎng)度和容量,切片支持追加、刪除等操作,但不能直接比較,數(shù)組長(zhǎng)度固定,切片可靈活擴(kuò)容,常用于動(dòng)態(tài)數(shù)據(jù)場(chǎng)景2025-09-09
使用Go?goroutine實(shí)現(xiàn)并發(fā)的Clock服務(wù)
這篇文章主要為大家詳細(xì)介紹了如何使用Go?goroutine實(shí)現(xiàn)并發(fā)的Clock服務(wù),文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2023-06-06

