广告
返回顶部
首页 > 资讯 > 后端开发 > GO >BeegoAutoRouter工作原理解析
  • 197
分享到

BeegoAutoRouter工作原理解析

2024-04-02 19:04:59 197人浏览 安东尼
摘要

目录一、前言 ?二、从一个例子入手✨?AutoRouter的解析规则:三、AutoRouter是如何工作的结语一、前言 ? BeeGo WEB框架应该是国内Go语言社区第一个框架,个

一、前言 ?

BeeGo WEB框架应该是国内Go语言社区第一个框架,个人觉得十分适合新手入门Go Web。笔者半年前写过一篇搭建Beego项目并实习简单功能的文章,大家有兴趣可以先看看。

其实我接触的大部分人都在学校学过JAVA WEB,其实有Java Web的经验,上手Beego也会很舒服。

本文着重讲讲Beego的AutoRouter模块,会结合源码来讲讲,不过由于笔者技术水平有限,如有错误,烦请指出。?

二、从一个例子入手✨

Beego的路由设计灵感是sinatra,刚开始并不支持自动路由,项目的每一个路由都需要开发者配置。

? 不过,在Beego里面注册一个路由是十分简单的,不信你看:

import "GitHub.com/beego/beego/v2/server/web"
type ReganYueController struct {
    web.Controller
}

接下来我们可以添加一个方法,也可以重写Get,Post,Delete等方法来响应客户端不同的请求方式。

import "github.com/beego/beego/v2/server/web"
type ReganYueController struct {
  web.Controller
}
func (u *ReganYueController) HelloWorld()  {
  u.Ctx.WriteString("Welcome, Regan Yue")
}
func main() {
  web.AutoRouter(&ReganYueController{})
  web.Run()
}

该处web.AutoRouter(&ReganYueController{})就是使用的自动路由,如果是以前的话,我们还需要配置路由? 。例如以下这种形式:

beego.Router("/", &IndexController{})

对于下面这段代码,有几点需要注意:

func (u *ReganYueController) HelloWorld()  {
  u.Ctx.WriteString("Welcome, Regan Yue")
}

⏰这个处理Http请求的方法必须是公共方法(首字母要大写),并且不能有参数,不能有返回值,若非如此,可能会发生Panic。

?AutoRouter的解析规则:

影响因素有三:

  • RouterCaseSensitive的值。
  • Controller的名字
  • 方法名字

比如我们上面ReganYueController的名字是ReganYue,而方法名字是HelloWorld,那么就会有以下几种情况出现:

  • 如果RouterCaseSensitivetrue,那么AutoRouter就会注册两个路由,其中一个是/ReganYue/HelloWorld/*,另一个是/reganyue/helloworld/*
  • 如果RouterCaseSensitivefalse,那么AutoRouter只会注册一个路由,即/reganyue/helloworld/*

三、AutoRouter是如何工作的

先看看web.AutoRouter()

// AutoRouter see httpserver.AutoRouter
func AutoRouter(c ControllerInterface) *HttpServer {
  return BeeApp.AutoRouter(c)
}

web.AutoRouter()马上又指向(app *HttpServer) AutoRouter(c ControllerInterface)

// AutoRouter adds defined controller handler to BeeApp.
// it's same to HttpServer.AutoRouter.
// if beego.AddAuto(&MainContorlller{}) and MainController has methods List and Page,
// visit the url /main/list to exec List function or /main/page to exec Page function.
func (app *HttpServer) AutoRouter(c ControllerInterface) *HttpServer {
  app.Handlers.AddAuto(c)
  return app
}

前面传来的主语BeeApp执行该处程序:

BeeApp是一个应用实例,使用NewHttpSever()创建,继续跟进,发现是根据Bconfig这个配置文件创建的,

// NewHttpServerWithCfg will create an sever with specific cfg
func NewHttpServerWithCfg(cfg *Config) *HttpServer {
  cr := NewControllerReGISterWithCfg(cfg)
  app := &HttpServer{
    Handlers: cr,
    Server:   &http.Server{},
    Cfg:      cfg,
  }
  return app
}

上图即配置Bconfig的主要结构。

到此我们对于BeeApp已经有一定了解了,下面我们回过头来看看app.Handlers.AddAuto(c)

先看看这个c是什么,它的类型是ControllerInterface,我们现在进去看看。

这个c是用来统一所有controller handler的接口。

根据上图我们可以知道,这个app.Handles就是ControllerRegister,再来看看ControllerRegister的AddAuto方法:

func (p *ControllerRegister) AddAuto(c ControllerInterface) {
  p.AddAutoPrefix("/", c)
}

AddAuto又指向AddAutoPrefix,这个AddAutoPrefix有什么用,我们先给出一个例子,然后再来看源码。

beego.AddAutoPrefix("/admin",&MainContorlller{})

如果MainContorlller有两个方法ListPage。那么我们可以访问/admin/main/list来执行List函数,访问/admin/main/page来执行Page函数

来看看ControllerRegister的AddAutoPrefix方法:

func (p *ControllerRegister) AddAutoPrefix(prefix string, c ControllerInterface) {
    //对传入的Controller做反射
  reflectVal := reflect.ValueOf(c)
    //获取传入的Controller的类型
  rt := reflectVal.Type()
    //因为c是指针,所以要用Indirect方法获取指针指向的变量类型
  ct := reflect.Indirect(reflectVal).Type()
    //使用Beego注册controller的名称后面有Controller,这里把它去掉得到controllerName。
  controllerName := strings.TrimSuffix(ct.Name(), "Controller")
    //
  for i := 0; i < rt.NumMethod(); i++ {
    if !utils.InSlice(rt.Method(i).Name, exceptMethod) {
      route := &ControllerInfo{}
      route.routerType = routerTypeBeego
      route.methods = map[string]string{"*": rt.Method(i).Name}
      route.controllerType = ct
      pattern := path.Join(prefix, strings.ToLower(controllerName), strings.ToLower(rt.Method(i).Name), "*")
      patternInit := path.Join(prefix, controllerName, rt.Method(i).Name, "*")
      patternFix := path.Join(prefix, strings.ToLower(controllerName), strings.ToLower(rt.Method(i).Name))
      patternFixInit := path.Join(prefix, controllerName, rt.Method(i).Name)
      route.pattern = pattern
      for m := range HTTPMETHOD {
        p.addToRouter(m, pattern, route)
        p.addToRouter(m, patternInit, route)
        p.addToRouter(m, patternFix, route)
        p.addToRouter(m, patternFixInit, route)
      }
    }
  }
}

reflectVal.Type()直接的获取传入的Controller的类型,而reflect.Indirect(reflectVal).Type(),interface其实就是两个指针,一个指向类型信息,一个指向实际的对象,用Indirect方法获取指针指向的实际变量的类型。

runtime/runtime2.go可以了解interface其实就是两个指针:

type iface struct {
        tab  *itab          //类型信息
        data unsafe.Pointer //实际对象指针
}
type itab struct {
        inter *interfacetype //接口类型
        _type *_type         //实际对象类型
        hash  uint32
        _     [4]byte
        fun   [1]uintptr     //实际对象方法地址
}

接下来是for i := 0; i < rt.NumMethod(); i++,我们来看看这个NumMethod(),可以看到这个方法获得interface类型的方法数量。

utils.InSlice()方法正如其名:

func InSlice(v string, sl []string) bool {
  for _, vv := range sl {
    if vv == v {
      return true
    }
  }
  return false
}

该方法是用来判断字符串v是不是在字符串切片sl里面。

此处判断方法名是不是在exceptMethod里面。

下面是exceptMethod的内容:

exceptMethod = []string{"Init", "Prepare", "Finish", "Render", "RenderString",
    "RenderBytes", "Redirect", "Abort", "StopRun", "UrlFor", "ServeJSON", "ServejsONP",
    "ServeYAML", "ServeXML", "Input", "ParseFORM", "GetString", "GetStrings", "GetInt", "GetBool",
    "GetFloat", "GetFile", "SaveToFile", "StartSession", "SetSession", "GetSession",
    "DelSession", "SessionRegenerateID", "DestroySession", "Isajax", "GetSecureCookie",
    "SetSecureCookie", "XsrfToken", "CheckXsrfCookie", "XsrfFormhtml",
    "GetControllerAndAction", "ServeFormatted"}

接下来创建了一个结构体,记录了controller的信息,下面几行代码就生成了每个方法对应的controller信息。

controller的pattern这里生成了4个模式:

  • prefix/全小写的controllerName/全小写的方法名/*
  • prefix/controllerName/方法名/*
  • prefix/全小写的controllerName/全小写的方法名
  • prefix/controllerName/方法名

然后对每一种HTTP方法:

都使用addToRouter方法用四种模式执行一遍。

下面看看addToRouter。

func (p *ControllerRegister) addToRouter(method, pattern string, r *ControllerInfo) {
  if !p.cfg.RouterCaseSensitive {
    pattern = strings.ToLower(pattern)
  }
  if t, ok := p.routers[method]; ok {
    t.AddRouter(pattern, r)
  } else {
    t := NewTree()
    t.AddRouter(pattern, r)
    p.routers[method] = t
  }
}
  • 如果RouterCaseSensitivetrue,那么AutoRouter就会注册两个路由,其中一个是/ReganYue/HelloWorld/*,另一个是/reganyue/helloworld/*
  • 如果RouterCaseSensitivefalse,那么AutoRouter只会注册一个路由,即/reganyue/helloworld/*

然后将method传给ControllerRegister,看是不是注册成功。

成功就执行:t.AddRouter(pattern, r)添加路由。

否则就执行:

t := NewTree()
t.AddRouter(pattern, r)
p.routers[method] = t

那就到此为止吧,

再爱就不礼貌了...

结语

本文通过源码解析,从一个例子入手,了解Beego的AutoRouter模块是如何工作的,以上就是Beego AutoRouter工作原理解析的详细内容,更多关于Beego AutoRouter工作原理的资料请关注编程网其它相关文章!

您可能感兴趣的文档:

--结束END--

本文标题: BeegoAutoRouter工作原理解析

本文链接: https://www.lsjlt.com/news/121069.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • BeegoAutoRouter工作原理解析
    目录一、前言 二、从一个例子入手✨AutoRouter的解析规则:三、AutoRouter是如何工作的结语一、前言 Beego Web框架应该是国内Go语言社区第一个框架,个人觉得...
    99+
    2022-11-11
  • reactSuspense工作原理解析
    目录Suspense 基本应用Suspense 原理基本流程源码解读 - primary 组件源码解读 - 异常捕获源码解读 - 添加 promise 回调源码解读-Suspense...
    99+
    2022-11-13
  • Android Handler工作原理解析
    简介 在Android 中,只有主线程才能操作 UI,但是主线程不能进行耗时操作,否则会阻塞线程,产生 ANR 异常,所以常常把耗时操作放到其它子线程进行。如果在子线程中需要...
    99+
    2022-06-06
    handler Android
  • Pinia介绍及工作原理解析
    目录什么是Pinia如何使用Pinia安装创建store在组件中使用store在模板中使用storePinia是如何工作的什么是Pinia Pinia是Vue 3的状态管理库,它提...
    99+
    2023-03-06
    Pinia工作原理 Pinia原理
  • Python 装饰器工作原理解析
    #!/usr/bin/env python #coding:utf-8 """ 装饰器实例拆解 """ def login00(func):     print('00请通过验证用户!')     return func def ...
    99+
    2023-01-31
    工作原理 Python
  • Vue状态管理工具Vuex工作原理解析
    目录一、什么是vuex二、vuex的工作方式三、vuex的使用场景四、工作流程五、vuex的核心API六、应用七、vuex的工作流程一、什么是vuex Vuex是vue项目的状态管理...
    99+
    2023-02-01
    Vue状态管理工具Vuex Vue状态管理器Vuex Vue Vuex
  • MySQL SSL 连接的工作原理解析
    MySQL是一款使用广泛的关系型数据库管理系统,它的安全性一直备受关注。SSL(Secure Socket Layer)是一种加密通信协议,用于提供安全的数据传输。MySQL SSL连接的工作原理即在MySQL数据库中使用SSL协议建立安全...
    99+
    2023-10-22
    用于存储和管理数据。 SSL: SSL(Secure Sockets Layer) 安全套接层
  • DHCP的工作原理分析
    这篇文章主要介绍了DHCP的工作原理分析,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。DHCP动态主机配置协议:计算机用来获得配置信息的协议。DHCP容许给某一计算机赋以IP...
    99+
    2023-06-27
  • 深入解析Golang中锁的工作原理
    Golang中锁的工作原理深度剖析引言:在并发编程中,避免竞态条件(race condition)是至关重要的。为了实现线程安全,Golang提供了丰富的锁机制。本文将深入剖析Golang中锁的工作原理,并提供具体的代码示例。一、互斥锁(M...
    99+
    2023-12-28
    (lock) 工作原理 (Working Principle) Golang (Golang)
  • 【mybatis】mybatis 拦截器工作原理源码解析
    mybatis 拦截器工作原理(JDK动态代理) 1. mybatis 拦截器案例 场景:分页查询,类似成熟产品:pagehelper, 这里只做简单原理演示 1.0 mybatis全局配置 SqlMapConfig.xml ...
    99+
    2015-01-18
    【mybatis】mybatis 拦截器工作原理源码解析
  • Linux NFS机制工作原理及实例解析
    什么是NFS? network file system 网络文件系统 通过网络存储和组织文件的一种方法或机制。 为什么要用NFS? 前端所有的应用服务器接收到用户上传的图片、文件、视频,都会统一放到后...
    99+
    2022-06-03
    Linux NFS机制
  • Springboot工作原理详解
    目录 一、Spring Boot 1.1.Spring Boot 优点  二、SpringBoot 运行原理 1.1. pom.xml  2.2. 主启动类的配置 3.3. 主启动类的运行 三、自动配置原理 3.1、启动类上注解的作用  3...
    99+
    2023-10-10
    spring boot java spring
  • 详解MyBatis工作原理
    目录一、Mybatis工作原理二、Mybatis运行原理总结一、Mybatis工作原理 Mybatis分层框架图 Mybatis工作原理图 源码分析:一般都是从helloworl...
    99+
    2022-11-12
  • SELINUX工作原理详解
    1. 简介 SElinux带给Linux的主要价值是:提供了一个灵活的,可配置的MAC机制。     Security-Enhanced Linux (SELinux)由以下两部分组成: ...
    99+
    2022-06-04
    SELINUX 工作原理
  • MySQL中的查询优化器工作原理解析
    MySQL是一种常用的关系型数据库管理系统,广泛应用于各种Web应用程序和大型企业级系统中。在MySQL的日常使用中,查询语句是最常见和重要的操作之一。为了提高查询效率和性能,MySQL引入了查询优化器。查询优化器是MySQL内部的一个组件...
    99+
    2023-10-22
    查询优化器 MySQL中 工作原理解析
  • 怎样理解HTTPS工作原理
    怎样理解HTTPS工作原理,针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。当你打开浏览器,访问某个网站,如果网址旁有个小锁,代表访问的网址是安全的,反之不安全。当我们没有看到...
    99+
    2023-06-17
  • Memcached工作原理的示例分析
    这篇文章主要介绍Memcached工作原理的示例分析,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!Memcached的工作原理。Memcached处理的原子是每一个(key,valu...
    99+
    2022-10-18
  • Node.js中require的工作原理浅析
    几乎所有的Node.js开发人员可以告诉你`require()`函数做什么,但我们又有多少人真正知道它是如何工作的?我们每天都使用它来加载库和模块,但它的行为,对于我们来说反而是一个谜。 出于好奇,我钻研了...
    99+
    2022-06-04
    工作原理 Node js
  • Struts2工作原理的示例分析
    这篇文章主要介绍Struts2工作原理的示例分析,文中介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们一定要看完!一、工作原理在Struts2框架中的处理大概分为以下几个步骤      ...
    99+
    2023-05-30
    struts2
  • 深入浅析HashMap的工作原理
    这篇文章给大家介绍深入浅析HashMap的工作原理,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。实际上,HashSet 和 HashMap 之间有很多相似之处,对于 HashSet 而言,系统采用 Hash 算法决定集...
    99+
    2023-05-31
    hashmap
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作