高质量编程与性能调优实战｜ 青训营

BearGia
44 阅读8分钟

高质量编程与性能调优实战

1、课程笔记 2、数据请求优化介绍 3、数据请求优化案例

课程笔记

编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码 实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的

  • 高质量的编程需要注意以下原则：简单性、可读性、生产力(提高整体效率)

常见编码规范

代码格式

  • 使用 gofmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致
  • goimports=gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母排序并分类 提升可读性，风格一致的代码更容易维护、需要更少的学习成本、团队合作成本，同时可以降低 Review 成本

注释

  • 注释应该解释代码作用：适合注释公共符号，
  • 注释应该解释代码如何做的：适合注释方法，注释实现过程
  • 注释应该解释代码实现的原因：解释代码的外部因素，提供额外上下文
  • 注释应该解释代码什么情况会出错，适合解释代码的限制条件
  • 公共符号始终要注释：包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释（不明显不简短的公共功能需要注释，不需要注释实现接口的方法） 代码是最好的注释，注释应该提供代码未表达出的上下文信息

命名规范

  • variable
    • 简洁胜于冗长
    • 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
    • 变量距离其被使用的地方越远，则需要携带越多的上下文信息
    • 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
  • function
    • 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
    • 函数名尽量简短
    • 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
    • 当名为 foo 的包某个函数返回类型 T 时（T 并不是 Foo），可以在函数名中加入类型信息
  • package
    • 只由小写字母组成。不包含大写字母和下划线等字符
    • 简短并包含一定的上下文信息。例如 schema、task 等
    • 不要与标准库同名。例如不要使用 sync 或者 strings
      • 尽量满足不使用常用变量名作为包名
      • 尽量满足使用单数而不是复数
      • 尽量满足谨慎使用缩写

关于命名的大多数规范核心在于考虑上下文，人们在阅读理解代码的时候也可以看成是计算机运行程序，好的命名能让人把关注点留在主流程上，清晰地理解程序的功能，避免频繁切换到分支细节，增加理解成本

控制流程

  • 避免嵌套，保持正常流程清晰
  • 如果两个分支中都包含 return 语句，则可以去除冗余的 else
  • 尽量保持正常代码路径为最小缩进，优先处理错误情况/特殊情况，并尽早返回或继续循环来减少嵌套，增加可读性
    • Go 公共库的代码
    • github.com/golang/go/b… 线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支;提高代码的可读性，故障大多出现在复杂的条件语句和循环语句中

错误和异常处理

  • 简单错误处理

    • 优先使用 errors.New 来创建匿名变量来直接表示该错误。有格式化需求时使用 fmt.Errorf

  • 错误的 Wrap 和 Unwrap

    • 在 fmt.Errorf 中使用 %w 关键字来将一个错误 wrap 至其错误链中
    • Go1.13 在 errors 中新增了三个新 API 和一个新的 format 关键字，分别是 errors.Is、errors.As 、errors.Unwrap 以及 fmt.Errorf 的 %w。如果项目运行在小于 Go1.13 的版本中，导入 golang.org/x/xerrors 来使用。以下语法均已 Go1.13 作为标准。

  • 错误判定

    • 使用 errors.Is 可以判定错误链上的所有错误是否含有特定的错误。
    • 在错误链上获取特定种类的错误，使用 errors.As

  • panic

    • 不建议在业务代码中使用 panic
    • 如果当前 goroutine 中所有 deferred 函数都不包含 recover 就会造成整个程序崩溃
    • 当程序启动阶段发生不可逆转的错误时，可以在 init 或 main 函数中使用 panic

  • recover

    • recover 只能在被 defer 的函数中使用，嵌套无法生效，只在当前 goroutine 生效
    • 如果需要更多的上下文信息，可以 recover 后在 log 中记录当前的调用栈。 panic 用于真正异常的情况 error 尽可能提供简明的上下文信息，方便定位问题 recover 生效范围，在当前 goroutine 的被 defer 的函数中生效

数据请求优化介绍

数据请求优化是指通过一系列的技术和策略，旨在减少网络请求的数量、优化数据传输大小以及提高数据请求的效率，从而提升应用的性能和响应速度。在现代的互联网应用中，数据请求通常是应用性能瓶颈的一个重要因素之一，因此优化数据请求对于提供优质用户体验至关重要。

以下是一些常见的数据请求优化策略和技术：

  1. 减少请求数量： 将多个请求合并成一个请求，从而减少服务器和客户端之间的往返次数。这可以通过合并 CSS、JavaScript 文件、图像精灵等方式实现。
  2. 数据压缩： 使用数据压缩技术，如Gzip或Brotli，可以在传输数据前将其压缩，从而减少数据的传输大小，提高传输效率。
  3. 使用缓存： 利用浏览器缓存或服务器缓存，避免重复请求相同的数据。缓存可以减少对服务器的请求次数，加快页面加载速度。
  4. 图片优化： 通过使用适当的图片格式、压缩和裁剪图片，可以减少图片文件的大小，降低网络传输开销。
  5. 懒加载： 对于页面上不可见的内容，可以采用懒加载技术，仅在用户滚动到可见区域时加载数据，避免不必要的请求。
  6. 预取数据： 提前加载可能需要的数据，以减少用户等待时间。例如，可以在用户浏览网页时预取下一页的数据。
  7. 使用CDN： 使用内容分发网络（CDN）可以将数据存储在全球分布的服务器上，从离用户更近的服务器获取数据，减少网络延迟。
  8. 数据分页： 对于大量数据，可以采用数据分页技术，仅获取需要展示的部分数据，降低单次请求的数据量。
  9. 异步加载： 使用异步请求（如Ajax）来获取数据，不阻塞页面的其他内容加载，提高用户体验。
  10. 数据格式优化： 使用高效的数据格式，如JSON、Protocol Buffers等，减少不必要的数据字段和格式冗余。
  11. HTTP/2： 使用HTTP/2协议，支持多路复用和头部压缩，提高并行请求和数据传输效率。

数据请求优化需要结合实际应用场景和需求进行，不同的项目可能需要采用不同的策略来达到最佳性能。通过综合运用上述策略，可以有效减少网络请求的开销，提高应用性能，为用户提供更快速、更高效的用户体验。

数据请求优化案例

通过一个数据请求优化的博客网站代码实现减少网络请求的数量、优化数据传输大小以及提高响应时间

  1. 初始实现：首先写一个最简单的数据请求代码。
package main

import (
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
)

type BlogPost struct {
	ID      int    `json:"id"`
	Title   string `json:"title"`
	Content string `json:"content"`
}

func getBlogPosts() ([]BlogPost, error) {
	resp, err := http.Get("https://api.example.com/blog/posts")
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		return nil, err
	}

	var posts []BlogPost
	err = json.Unmarshal(body, &posts)
	if err != nil {
		return nil, err
	}

	return posts, nil
}

func main() {
	posts, err := getBlogPosts()
	if err != nil {
		fmt.Println("Error:", err)
		return
	}

	for _, post := range posts {
		fmt.Printf("Title: %s\n", post.Title)
	}
}
  1. 数据请求优化： 获取多篇博客文章的详细内容。为了减少网络请求的数量，可以一次性获取所有文章的详细内容。
func getBlogPostsAndDetails() ([]BlogPost, error) {
	resp, err := http.Get("https://api.example.com/blog/posts")
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

	body, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		return nil, err
	}

	var posts []BlogPost
	err = json.Unmarshal(body, &posts)
	if err != nil {
		return nil, err
	}

	for i := range posts {
		detailResp, err := http.Get(fmt.Sprintf("https://api.example.com/blog/posts/%d", posts[i].ID))
		if err != nil {
			return nil, err
		}
		defer detailResp.Body.Close()

		detailBody, err := ioutil.ReadAll(detailResp.Body)
		if err != nil {
			return nil, err
		}

		err = json.Unmarshal(detailBody, &posts[i])
		if err != nil {
			return nil, err
		}
	}

	return posts, nil
}
avatar
文章
阅读
粉丝