Hura! Mamy wreszcie przyjemność udostępnić wam polską wersję! Zapraszamy do przesyłania wiadomości z waszymi uwagami i informacjami o zauważonych błędach.
Metoda szablonowa

Metoda szablonowa w języku Go

Metoda szablonowa to behawioralny wzorzec projektowy według którego definiuje się szkielet algorytmu w klasie bazowej i pozwala klasom pochodnym nadpisać poszczególne jego etapy bez zmiany ogólnej struktury.

Przykład koncepcyjny

Weźmy pod uwagę przykład funkcjonalności Haseł Jednorazowych (OTP — One Time Password). Są różne sposoby dostarczenia takiego hasła użytkownikowi (SMS, email, itp.), jednak niezależnie od sposobu cały proces jest taki sam:

  1. Wygeneruj losową n-cyfrową liczbę.
  2. Zapisz wygenerowaną liczbę w pamięci podręcznej w celu późniejszej weryfikacji.
  3. Przygotuj zawartość.
  4. Wyślij powiadomienie.
  5. Opublikuj metrykę.

Ewentualne nowe typy haseł jednorazowych wprowadzone później najprawdopodobniej będą tworzone w analogiczny sposób.

Mamy więc scenariusz w którym etapy pewnej operacji są takie same, a różna jest tylko ich konkretna implementacja. Świetna okazja do posłużenia się wzorcem Metoda szablonowa.

Najpierw definiujemy bazowy szablon algorytmu składający się z pewnej liczby metod. To będzie nasza metoda szablonowa. Następnie zaimplementujemy każdy z etapów, ale pozostawimy metodę szablonową w postaci niezmienionej.

otp.go: Metoda szablonowa

package main

type iOtp interface {
	genRandomOTP(int) string
	saveOTPCache(string)
	getMessage(string) string
	sendNotification(string) error
	publishMetric()
}

// type otp struct {
// }

// func (o *otp) genAndSendOTP(iOtp iOtp, otpLength int) error {
// 	otp := iOtp.genRandomOTP(otpLength)
// 	iOtp.saveOTPCache(otp)
// 	message := iOtp.getMessage(otp)
// 	err := iOtp.sendNotification(message)
// 	if err != nil {
// 		return err
// 	}
// 	iOtp.publishMetric()
// 	return nil
// }

type otp struct {
	iOtp iOtp
}

func (o *otp) genAndSendOTP(otpLength int) error {
	otp := o.iOtp.genRandomOTP(otpLength)
	o.iOtp.saveOTPCache(otp)
	message := o.iOtp.getMessage(otp)
	err := o.iOtp.sendNotification(message)
	if err != nil {
		return err
	}
	o.iOtp.publishMetric()
	return nil
}

sms.go: Konkretna implementacja

package main

import "fmt"

type sms struct {
	otp
}

func (s *sms) genRandomOTP(len int) string {
	randomOTP := "1234"
	fmt.Printf("SMS: generating random otp %s\n", randomOTP)
	return randomOTP
}

func (s *sms) saveOTPCache(otp string) {
	fmt.Printf("SMS: saving otp: %s to cache\n", otp)
}

func (s *sms) getMessage(otp string) string {
	return "SMS OTP for login is " + otp
}

func (s *sms) sendNotification(message string) error {
	fmt.Printf("SMS: sending sms: %s\n", message)
	return nil
}

func (s *sms) publishMetric() {
	fmt.Printf("SMS: publishing metrics\n")
}

email.go: Konkretna implementacja

package main

import "fmt"

type email struct {
	otp
}

func (s *email) genRandomOTP(len int) string {
	randomOTP := "1234"
	fmt.Printf("EMAIL: generating random otp %s\n", randomOTP)
	return randomOTP
}

func (s *email) saveOTPCache(otp string) {
	fmt.Printf("EMAIL: saving otp: %s to cache\n", otp)
}

func (s *email) getMessage(otp string) string {
	return "EMAIL OTP for login is " + otp
}

func (s *email) sendNotification(message string) error {
	fmt.Printf("EMAIL: sending email: %s\n", message)
	return nil
}

func (s *email) publishMetric() {
	fmt.Printf("EMAIL: publishing metrics\n")
}

main.go: Kod klienta

package main

import "fmt"

func main() {
	// otp := otp{}

	// smsOTP := &sms{
	// 	otp: otp,
	// }

	// smsOTP.genAndSendOTP(smsOTP, 4)

	// emailOTP := &email{
	// 	otp: otp,
	// }
	// emailOTP.genAndSendOTP(emailOTP, 4)
	// fmt.Scanln()
	smsOTP := &sms{}
	o := otp{
		iOtp: smsOTP,
	}
	o.genAndSendOTP(4)

	fmt.Println("")
	emailOTP := &email{}
	o = otp{
		iOtp: emailOTP,
	}
	o.genAndSendOTP(4)

}

output.txt: Wynik działania

SMS: generating random otp 1234
SMS: saving otp: 1234 to cache
SMS: sending sms: SMS OTP for login is 1234
SMS: publishing metrics

EMAIL: generating random otp 1234
EMAIL: saving otp: 1234 to cache
EMAIL: sending email: EMAIL OTP for login is 1234
EMAIL: publishing metrics
Na podstawie: Golang By Example

Metoda szablonowa w innych językach

Wzorce projektowe: Metoda szablonowa w języku Java Wzorce projektowe: Metoda szablonowa w języku C# Wzorce projektowe: Metoda szablonowa w języku C++ Wzorce projektowe: Metoda szablonowa w języku PHP Wzorce projektowe: Metoda szablonowa w języku Python Wzorce projektowe: Metoda szablonowa w języku Ruby Wzorce projektowe: Metoda szablonowa w języku Swift Wzorce projektowe: Metoda szablonowa w języku TypeScript