📚
handbook
  • Introduction
  • 1.前言
    • 前言
    • 鸣谢
  • 2.环境篇
    • 工具部署和使用
      • 团队协作工具
        • Confluence
      • 开发工具
        • Docker
          • 镜像导入导出
          • 安装
        • Docker Compose
      • 持续集成工具
        • Gerrit
        • Sonarqube
          • 分析参数设定
          • Prerequisite
          • 服务端设置
        • Ubuntu Ci Deploy
          • ubuntu使用docker部署jenkins+sonarqube
        • 持续集成部署
      • 文本编辑工具
        • Gitbook相关注意事项
        • Markdown快速入门
      • 版本控制
        • Git
          • 1.基础
            • Git基础(一)
            • Git基础(二)
            • Git基础(三)
            • Git基础(四)
            • Git基础(五)
          • 2.命令详解
            • 命令速查
          • 3.进阶技巧
            • git技巧
      • 自动化测试工具
        • Appium
          • capability参数配置
          • 安装
          • 简介
      • 项目管理工具
        • Jira
    • 开发环境配置
      • 通用
        • Homebrew安装与使用
        • Git服务器添加SSH Key
        • koroFileHeader使用
        • nodejs与npm的安装
        • npm更换国内源
        • pip使用相关
        • PostgreSQL安装与使用
        • proxychain安装与使用
        • shell配置环境变量
        • snapd安装与使用
        • terminal走代理
    • 快捷键速查
      • shell常用快捷键
  • 3.语言篇
    • C
      • 代码规范
      • 语言技巧
    • Cpp
      • 代码规范
      • 基础知识
        • 理解C++中的左值和右值
      • 语言技巧
        • 并发编程
          • 简单的线程池实现
    • Golang
      • 代码规范
        • 避免使用转义字符串
        • 避免参数语义不明确
        • 嵌套式结构体
        • 函数的分组与顺序
        • 函数命名
        • 声明一致性
        • 导入别名
        • 使用字段名初始化结构体
        • 本地变量声明
        • map初始化
        • nil用法
        • 包命名
        • 命名Printf样式的函数
        • 减少嵌套
        • 缩小变量作用域
        • struct引用初始化
        • 测试表声明
        • 顶层变量声明
        • 不必要的else
      • 环境配置
        • 代码检查格式化工具
          • Go Fmt
          • Goimports
          • Golint
          • Go Vet
        • go mod详解
        • golang安装
        • Golang开发环境
        • Troubleshooting
      • 语言技巧
        • 如何分包
    • Java
      • 代码规范
      • 语言技巧
        • 注解编程
        • 动态代理
    • Js
      • 语言技巧
        • Rollup
    • Kotlin
      • 基础知识
        • 写给开发者Kotlin指引(一)
        • 写给开发者Kotlin指引(二)
    • Python
      • 语言技巧
        • Best Practice Of Python S Project Structure
  • 4.规范篇
    • Git message规范
  • 5.技术篇
    • Android技术
      • Hook
        • EdXposed例子
        • Android 10 上安装Magisk和EdXposed
      • Tinker
        • 1.Tinker及其使用
      • 准备
        • ADB连接设备步骤及注意事项
        • adb连接设备
        • aosp编译
      • 基础
        • Binder接口调用的鉴权方法
        • Make 及 Android 编译系统介绍
        • 使用Content Provider为其他应用提供数据
      • 源码阅读
        • Framework源码分析 Looper Handler
        • Framework源码分析 启动流程 ServiceManager的初始化
        • Framework源码分析 启动流程 Zygote启动SystemServer
    • JS Bridge
      • JSBridge初探
    • Kernel技术
      • kallsyms子系统
    • Test技术
      • 软件测试
        • jnekin+sonar 部署 问题总结
        • 性能测试基础
        • 软件测试的背景
        • 测试基础
        • 测试人员的核心竞争力
    • 操作系统原理
      • 处理器如何实现原子操作
Powered by GitBook
On this page
  • 一、去除无意义包
  • 1.1 案例分析
  • 1.2 解决方法

Was this helpful?

  1. 3.语言篇
  2. Golang
  3. 语言技巧

如何分包

Previous语言技巧NextJava

Last updated 4 years ago

Was this helpful?

良好的分包让代码更加清晰,本节主要讲述在不同场景下分包的方法,关于包命名请参考。

一、去除无意义包

golang中禁止使用类似util的无意义包名,有时开发者会将专门使用api来给提供用户使用的包命名,看似加速了代码的定位,但随着包体积的增长,将越来越难以维护包之间的依赖关系。

1.1 案例分析

考虑这样的util包结构:

utils/
├── concurrency.go
├── file.go
├── file_test.go
├── rander.go
├── rand.go
├── rand_test.go
├── string.go
├── testdata
│   ├── existdir
│   │   └── existfile
│   ├── files
│   │   ├── xxx.toml
│   │   └── xxx.txt
│   └── so
│       └── CVE_2017_0427.so
├── utils.go
└── utils_test.go

该包从命名到组织有如下错误:

  1. 使用复数utils作为包名;

  2. 使用含义不清的utils作为包名。

1.2 解决方法

将该包的内容进行分离,例如file.go中的函数有:

func IsExist(path string) bool
func CreatePath(filePath string) error
func RemovePath(filePath string) error
func GetAllFiles(dirPth string, suffix string) (files []string, err error)
func ReadFile(path string) ([]byte, error)
func WriteFile(filePath string, content string) error

该文件前四个函数是对文件系统的操作,而后两个函数则是文件I/O操作,在进行分包时应为文件系统创建fs或filesystem包,为文件I/O操作创建fileio包,并将函数分别移入。修改后的文件结构应为:

fs/
├── fs.go
└── fs_test.go
fileio/
├── fileio.go
└── fileio_test.go

对于utils中其他组件同样按照功能进行分包。

包命名