用go封装一下封禁功用

本篇为用go设计开发一个自己的轻量级登录库/结构吧 – 秋玻 – 博客园 (cnblogs.com)的封禁事务篇，会讲讲封禁事务的完成，给库/结构添加新的功用。

源码：github.com/weloe/token…

思路

封禁事务也是在一般项目中比较常见的事务。咱们也将它封装在库中作为功用之一。

咱们同样运用adapter作为底层的存储结构，将封禁标明作为k-v结构存储。

把id和服务名称service作为key，把封禁的等级level作为value，以此咱们能完成一些比较常见的封禁事务。

完成

首要就是封禁办法，首要当然要校验一下参数，然后存储封禁标识。要注意的就是level要大于等于1，在封禁后也要调用咱们的logger和watcher。

github.com/weloe/token…

// Banned ban user, if time == 0,the timeout is not set
func (e *Enforcer) Banned(id string, service string, level int, time int64) error {
	if id == "" || service == "" {
		return fmt.Errorf("parameter cannot be nil")
	}
	if level < 1 {
		return fmt.Errorf("unexpected level = %v, level must large or equal 1", level)
	}
	err := e.adapter.SetStr(e.spliceBannedKey(id, service), strconv.Itoa(level), time)
	if err != nil {
		return err
	}
	// callback
	e.logger.Ban(e.loginType, id, service, level, time)
	if e.watcher != nil {
		e.watcher.Ban(e.loginType, id, service, level, time)
	}
	return nil
}

再来就是免除封禁的完成，很简单，只要删去咱们封禁存的那条记载就可以了。

github.com/weloe/token…

// UnBanned Unblock user account
func (e *Enforcer) UnBanned(id string, services ...string) error {
	if id == "" {
		return fmt.Errorf("parmeter id can not be nil")
	}
	if len(services) == 0 {
		return fmt.Errorf("parmeter services length can not be 0")
	}
	for _, service := range services {
		err := e.adapter.DeleteStr(e.spliceBannedKey(id, service))
		if err != nil {
			return err
		}
		e.logger.UnBan(e.loginType, id, service)
		if e.watcher != nil {
			e.watcher.UnBan(e.loginType, id, service)
		}
	}
	return nil
}

接着还需求供给几个方便运用的办法

分别用来判别是否被封禁，取得封禁的等级，取得封禁的剩余时间三个办法

github.com/weloe/token…

判别是否被封禁

// IsBanned if banned return true, else return false
func (e *Enforcer) IsBanned(id string, services string) bool {
	s := e.adapter.GetStr(e.spliceBannedKey(id, services))
	return s != ""
}

github.com/weloe/token…

取得封禁的等级

// GetBannedLevel get banned level
func (e *Enforcer) GetBannedLevel(id string, service string) (int64, error) {
	str := e.adapter.GetStr(e.spliceBannedKey(id, service))
	if str == "" {
		return 0, fmt.Errorf("loginId = %v, service = %v is not banned", id, service)
	}
	time, err := strconv.ParseInt(str, 10, 64)
	if err != nil {
		return 0, err
	}
	return time, nil
}

github.com/weloe/token…

取得封禁的剩余时间

// GetBannedTime get banned time
func (e *Enforcer) GetBannedTime(id string, service string) int64 {
	timeout := e.adapter.GetStrTimeout(e.spliceBannedKey(id, service))
	return timeout
}

有了这几个办法，咱们就可以运用token-go更为方就是完成登录事务了。

对于一般的事务，咱们其实可以无视封禁等级。只需求运用Banned()进行封禁，在每个需求校验是否被封禁的事务前进行IsBanned()的判别就行了。

测试例子：

func TestEnforcer_Banned(t *testing.T) {
	err, enforcer, _ := NewTestEnforcer(t)
	if err != nil {
		t.Fatalf("NewTestEnforcer() failed: %v", err)
	}
	err = enforcer.Banned("1", "comment", 1, 100)
	if err != nil {
		t.Fatalf("Banned() failed: %v", err)
	}
	isBanned := enforcer.IsBanned("1", "comment")
	if !isBanned {
		t.Errorf("unexpected isBanned is false")
	}
	err = enforcer.UnBanned("1", "comment")
	if err != nil {
		t.Fatalf("UnBanned() failed: %v", err)
	}
	isBanned = enforcer.IsBanned("1", "comment")
	if isBanned {
		t.Errorf("unexpected isBanned is false")
	}
}

当然咱们对于一个事务会有一些较为杂乱的封禁，比如discuss沟通事务，假如等级为1咱们会制止评论，假如等级为2咱们会制止评论和点赞，等级为3咱们会制止评论、点赞和保藏。

这个时候咱们只需求再加上GetBannedLevel()，在每个事务前获取封禁等级进行判别就可以简单的完成了。