dep-analyzer.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540
  1. package main
  2. import (
  3. "encoding/json"
  4. "flag"
  5. "fmt"
  6. "go/parser"
  7. "go/token"
  8. "os"
  9. "path/filepath"
  10. "sort"
  11. "strings"
  12. "sync"
  13. )
  14. // DependencyGraph 表示依赖关系图
  15. type DependencyGraph struct {
  16. Packages map[string]*PackageInfo
  17. Mutex sync.RWMutex
  18. }
  19. // PackageInfo 表示包的信息
  20. type PackageInfo struct {
  21. Name string
  22. Path string
  23. Imports []string
  24. ImportedBy []string
  25. IsExternal bool
  26. IsStandard bool
  27. }
  28. // DependencyEdge 表示依赖边
  29. type DependencyEdge struct {
  30. From string `json:"from"`
  31. To string `json:"to"`
  32. }
  33. // DependencyOutput 输出结构
  34. type DependencyOutput struct {
  35. Packages []PackageOutput `json:"packages"`
  36. Edges []DependencyEdge `json:"edges"`
  37. }
  38. // PackageOutput 包输出结构
  39. type PackageOutput struct {
  40. Name string `json:"name"`
  41. Path string `json:"path"`
  42. Imports []string `json:"imports"`
  43. ImportedBy []string `json:"imported_by,omitempty"`
  44. IsExternal bool `json:"is_external"`
  45. IsStandard bool `json:"is_standard"`
  46. }
  47. func main() {
  48. // 解析命令行参数
  49. rootDir := flag.String("dir", ".", "要扫描的Go工程目录")
  50. outputFormat := flag.String("format", "text", "输出格式: text, json, dot, csv")
  51. outputFile := flag.String("output", "", "输出文件路径(默认输出到控制台)")
  52. ignoreStdLib := flag.Bool("ignore-std", false, "忽略标准库依赖")
  53. includeTests := flag.Bool("include-tests", false, "包含测试文件")
  54. flag.Parse()
  55. // 检查目录是否存在
  56. if _, err := os.Stat(*rootDir); os.IsNotExist(err) {
  57. fmt.Printf("错误: 目录不存在: %s\n", *rootDir)
  58. os.Exit(1)
  59. }
  60. // 构建依赖图
  61. graph := &DependencyGraph{
  62. Packages: make(map[string]*PackageInfo),
  63. }
  64. fmt.Printf("正在扫描目录: %s\n", *rootDir)
  65. // 扫描Go文件
  66. err := scanDirectory(*rootDir, graph, *includeTests)
  67. if err != nil {
  68. fmt.Printf("扫描错误: %v\n", err)
  69. os.Exit(1)
  70. }
  71. // 计算导入关系
  72. calculateImportedBy(graph)
  73. // 生成输出
  74. output := generateOutput(graph, *ignoreStdLib)
  75. // 输出结果
  76. err = outputResult(output, *outputFormat, *outputFile)
  77. if err != nil {
  78. fmt.Printf("输出错误: %v\n", err)
  79. os.Exit(1)
  80. }
  81. fmt.Printf("\n扫描完成! 共发现 %d 个包,%d 个依赖关系\n",
  82. len(output.Packages), len(output.Edges))
  83. }
  84. // scanDirectory 递归扫描目录
  85. func scanDirectory(dir string, graph *DependencyGraph, includeTests bool) error {
  86. return filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
  87. if err != nil {
  88. return err
  89. }
  90. // 跳过vendor目录和隐藏目录
  91. if info.IsDir() {
  92. if strings.Contains(path, "vendor") || strings.HasPrefix(filepath.Base(path), ".") {
  93. return filepath.SkipDir
  94. }
  95. return nil
  96. }
  97. // 只处理.go文件
  98. if filepath.Ext(path) != ".go" {
  99. return nil
  100. }
  101. // 可选跳过测试文件
  102. if !includeTests && strings.HasSuffix(path, "_test.go") {
  103. return nil
  104. }
  105. // 解析Go文件
  106. analyzeGoFile(path, graph)
  107. return nil
  108. })
  109. }
  110. // analyzeGoFile 分析单个Go文件
  111. func analyzeGoFile(filePath string, graph *DependencyGraph) {
  112. fset := token.NewFileSet()
  113. node, err := parser.ParseFile(fset, filePath, nil, parser.ImportsOnly)
  114. if err != nil {
  115. fmt.Printf("警告: 无法解析文件 %s: %v\n", filePath, err)
  116. return
  117. }
  118. // 获取包名和相对路径
  119. relPath, _ := filepath.Rel(".", filepath.Dir(filePath))
  120. if relPath == "." {
  121. relPath = ""
  122. }
  123. packagePath := relPath
  124. if packagePath == "" {
  125. packagePath = "."
  126. }
  127. // 创建或获取包信息
  128. graph.Mutex.Lock()
  129. packageInfo, exists := graph.Packages[packagePath]
  130. if !exists {
  131. packageInfo = &PackageInfo{
  132. Name: node.Name.Name,
  133. Path: packagePath,
  134. Imports: []string{},
  135. ImportedBy: []string{},
  136. }
  137. graph.Packages[packagePath] = packageInfo
  138. }
  139. graph.Mutex.Unlock()
  140. // 收集导入
  141. var imports []string
  142. for _, imp := range node.Imports {
  143. importPath := strings.Trim(imp.Path.Value, `"`)
  144. imports = append(imports, importPath)
  145. }
  146. // 更新导入列表(去重)
  147. graph.Mutex.Lock()
  148. existingImports := make(map[string]bool)
  149. for _, imp := range packageInfo.Imports {
  150. existingImports[imp] = true
  151. }
  152. for _, imp := range imports {
  153. if !existingImports[imp] {
  154. packageInfo.Imports = append(packageInfo.Imports, imp)
  155. }
  156. }
  157. graph.Mutex.Unlock()
  158. }
  159. // calculateImportedBy 计算每个包被哪些包导入
  160. func calculateImportedBy(graph *DependencyGraph) {
  161. graph.Mutex.Lock()
  162. defer graph.Mutex.Unlock()
  163. // 清空现有的importedBy
  164. for _, pkg := range graph.Packages {
  165. pkg.ImportedBy = []string{}
  166. pkg.IsExternal = false
  167. pkg.IsStandard = true // 先假设是标准库,后续会修正
  168. }
  169. // 遍历所有包,构建导入关系
  170. for pkgPath, pkg := range graph.Packages {
  171. for _, imp := range pkg.Imports {
  172. // 标记外部包和标准库
  173. if isStandardPackage(imp) {
  174. // 如果是标准库,检查是否在已有包中
  175. if _, exists := graph.Packages[imp]; !exists {
  176. graph.Packages[imp] = &PackageInfo{
  177. Name: filepath.Base(imp),
  178. Path: imp,
  179. IsStandard: true,
  180. }
  181. }
  182. } else {
  183. // 外部包
  184. if importedPkg, exists := graph.Packages[imp]; exists {
  185. importedPkg.IsExternal = true
  186. importedPkg.IsStandard = false
  187. }
  188. }
  189. // 添加importedBy关系
  190. if importedPkg, exists := graph.Packages[imp]; exists {
  191. importedPkg.ImportedBy = append(importedPkg.ImportedBy, pkgPath)
  192. }
  193. }
  194. }
  195. // 标记项目内部的包
  196. for pkgPath, pkg := range graph.Packages {
  197. if _, exists := graph.Packages[pkgPath]; exists && !pkg.IsExternal {
  198. // 如果路径中包含.或者没有/,可能是本地包
  199. if strings.Contains(pkgPath, ".") || !strings.Contains(pkgPath, "/") {
  200. pkg.IsStandard = true
  201. } else {
  202. pkg.IsStandard = false
  203. }
  204. }
  205. }
  206. }
  207. // isStandardPackage 检查是否是标准库包
  208. func isStandardPackage(pkgPath string) bool {
  209. // 标准库通常不包含域名
  210. if strings.Contains(pkgPath, ".") {
  211. return false
  212. }
  213. // 常见的一级标准库目录
  214. stdLibs := map[string]bool{
  215. "fmt": true,
  216. "io": true,
  217. "net": true,
  218. "http": true,
  219. "os": true,
  220. "strings": true,
  221. "strconv": true,
  222. "encoding": true,
  223. "json": true,
  224. "xml": true,
  225. "time": true,
  226. "sync": true,
  227. "math": true,
  228. "sort": true,
  229. "container": true,
  230. "crypto": true,
  231. "database": true,
  232. "debug": true,
  233. "embed": true,
  234. "errors": true,
  235. "expvar": true,
  236. "flag": true,
  237. "go": true,
  238. "hash": true,
  239. "html": true,
  240. "image": true,
  241. "index": true,
  242. "log": true,
  243. "mime": true,
  244. "path": true,
  245. "reflect": true,
  246. "regexp": true,
  247. "runtime": true,
  248. "testing": true,
  249. "text": true,
  250. "unicode": true,
  251. "unsafe": true,
  252. }
  253. // 获取第一级目录
  254. firstPart := pkgPath
  255. if idx := strings.Index(pkgPath, "/"); idx != -1 {
  256. firstPart = pkgPath[:idx]
  257. }
  258. return stdLibs[firstPart]
  259. }
  260. // generateOutput 生成输出数据
  261. func generateOutput(graph *DependencyGraph, ignoreStdLib bool) *DependencyOutput {
  262. graph.Mutex.RLock()
  263. defer graph.Mutex.RUnlock()
  264. output := &DependencyOutput{
  265. Packages: []PackageOutput{},
  266. Edges: []DependencyEdge{},
  267. }
  268. // 收集包信息
  269. var packagePaths []string
  270. for pkgPath := range graph.Packages {
  271. packagePaths = append(packagePaths, pkgPath)
  272. }
  273. sort.Strings(packagePaths)
  274. for _, pkgPath := range packagePaths {
  275. pkg := graph.Packages[pkgPath]
  276. // 如果忽略标准库且当前包是标准库,则跳过
  277. if ignoreStdLib && pkg.IsStandard {
  278. continue
  279. }
  280. // 添加包信息
  281. pkgOutput := PackageOutput{
  282. Name: pkg.Name,
  283. Path: pkg.Path,
  284. Imports: make([]string, len(pkg.Imports)),
  285. ImportedBy: make([]string, len(pkg.ImportedBy)),
  286. IsExternal: pkg.IsExternal,
  287. IsStandard: pkg.IsStandard,
  288. }
  289. copy(pkgOutput.Imports, pkg.Imports)
  290. copy(pkgOutput.ImportedBy, pkg.ImportedBy)
  291. output.Packages = append(output.Packages, pkgOutput)
  292. // 添加依赖边(排除指向被忽略的标准库的边)
  293. for _, imp := range pkg.Imports {
  294. if importedPkg, exists := graph.Packages[imp]; exists {
  295. if ignoreStdLib && importedPkg.IsStandard {
  296. continue
  297. }
  298. output.Edges = append(output.Edges, DependencyEdge{
  299. From: pkgPath,
  300. To: imp,
  301. })
  302. }
  303. }
  304. }
  305. return output
  306. }
  307. // outputResult 输出结果
  308. func outputResult(output *DependencyOutput, format string, outputFile string) error {
  309. var result string
  310. var err error
  311. switch format {
  312. case "json":
  313. result, err = outputJSON(output)
  314. case "dot":
  315. result, err = outputDOT(output)
  316. case "csv":
  317. result, err = outputCSV(output)
  318. default: // text
  319. result, err = outputText(output)
  320. }
  321. if err != nil {
  322. return err
  323. }
  324. // 输出到文件或控制台
  325. if outputFile != "" {
  326. err = os.WriteFile(outputFile, []byte(result), 0644)
  327. if err != nil {
  328. return err
  329. }
  330. fmt.Printf("结果已保存到: %s\n", outputFile)
  331. } else {
  332. fmt.Println(result)
  333. }
  334. return nil
  335. }
  336. // outputText 文本格式输出
  337. func outputText(output *DependencyOutput) (string, error) {
  338. var builder strings.Builder
  339. builder.WriteString("=== 包依赖分析报告 ===\n\n")
  340. // 按类型分组
  341. var stdPackages, localPackages, extPackages []PackageOutput
  342. for _, pkg := range output.Packages {
  343. if pkg.IsStandard {
  344. stdPackages = append(stdPackages, pkg)
  345. } else if pkg.IsExternal {
  346. extPackages = append(extPackages, pkg)
  347. } else {
  348. localPackages = append(localPackages, pkg)
  349. }
  350. }
  351. // 输出本地包
  352. if len(localPackages) > 0 {
  353. builder.WriteString("本地包:\n")
  354. for _, pkg := range localPackages {
  355. builder.WriteString(fmt.Sprintf(" %s (%s)\n", pkg.Path, pkg.Name))
  356. if len(pkg.Imports) > 0 {
  357. builder.WriteString(" 导入:\n")
  358. for _, imp := range pkg.Imports {
  359. builder.WriteString(fmt.Sprintf(" - %s\n", imp))
  360. }
  361. }
  362. if len(pkg.ImportedBy) > 0 {
  363. builder.WriteString(" 被以下包导入:\n")
  364. for _, by := range pkg.ImportedBy {
  365. builder.WriteString(fmt.Sprintf(" - %s\n", by))
  366. }
  367. }
  368. builder.WriteString("\n")
  369. }
  370. }
  371. // 输出外部包
  372. if len(extPackages) > 0 {
  373. builder.WriteString("外部依赖:\n")
  374. for _, pkg := range extPackages {
  375. builder.WriteString(fmt.Sprintf(" %s\n", pkg.Path))
  376. if len(pkg.ImportedBy) > 0 {
  377. builder.WriteString(" 被以下包导入:\n")
  378. for _, by := range pkg.ImportedBy {
  379. builder.WriteString(fmt.Sprintf(" - %s\n", by))
  380. }
  381. }
  382. builder.WriteString("\n")
  383. }
  384. }
  385. // 输出标准库(简略)
  386. if len(stdPackages) > 0 {
  387. builder.WriteString("标准库依赖:\n")
  388. libs := make(map[string]bool)
  389. for _, pkg := range stdPackages {
  390. libs[pkg.Path] = true
  391. }
  392. var libList []string
  393. for lib := range libs {
  394. libList = append(libList, lib)
  395. }
  396. sort.Strings(libList)
  397. for _, lib := range libList {
  398. builder.WriteString(fmt.Sprintf(" %s\n", lib))
  399. }
  400. }
  401. // 依赖统计
  402. builder.WriteString("\n=== 依赖统计 ===\n")
  403. builder.WriteString(fmt.Sprintf("总包数: %d\n", len(output.Packages)))
  404. builder.WriteString(fmt.Sprintf("本地包: %d\n", len(localPackages)))
  405. builder.WriteString(fmt.Sprintf("外部包: %d\n", len(extPackages)))
  406. builder.WriteString(fmt.Sprintf("标准库: %d\n", len(stdPackages)))
  407. builder.WriteString(fmt.Sprintf("依赖关系数: %d\n", len(output.Edges)))
  408. return builder.String(), nil
  409. }
  410. // outputJSON JSON格式输出
  411. func outputJSON(output *DependencyOutput) (string, error) {
  412. data, err := json.MarshalIndent(output, "", " ")
  413. if err != nil {
  414. return "", err
  415. }
  416. return string(data), nil
  417. }
  418. // outputDOT DOT格式输出(用于Graphviz)
  419. func outputDOT(output *DependencyOutput) (string, error) {
  420. var builder strings.Builder
  421. builder.WriteString("digraph GoDependencies {\n")
  422. builder.WriteString(" rankdir=LR;\n")
  423. builder.WriteString(" node [shape=box, style=filled];\n\n")
  424. // 定义节点
  425. for _, pkg := range output.Packages {
  426. color := "lightblue"
  427. if pkg.IsExternal {
  428. color = "lightcoral"
  429. } else if pkg.IsStandard {
  430. color = "lightgrey"
  431. }
  432. builder.WriteString(fmt.Sprintf(" \"%s\" [label=\"%s\", fillcolor=\"%s\"];\n",
  433. pkg.Path, pkg.Path, color))
  434. }
  435. builder.WriteString("\n")
  436. // 定义边
  437. for _, edge := range output.Edges {
  438. builder.WriteString(fmt.Sprintf(" \"%s\" -> \"%s\";\n", edge.From, edge.To))
  439. }
  440. builder.WriteString("}\n")
  441. return builder.String(), nil
  442. }
  443. // outputCSV CSV格式输出
  444. func outputCSV(output *DependencyOutput) (string, error) {
  445. var builder strings.Builder
  446. // 写表头
  447. builder.WriteString("From,To,Type\n")
  448. // 写数据
  449. for _, edge := range output.Edges {
  450. toPkg := findPackage(output.Packages, edge.To)
  451. depType := "local"
  452. if toPkg != nil {
  453. if toPkg.IsExternal {
  454. depType = "external"
  455. } else if toPkg.IsStandard {
  456. depType = "standard"
  457. }
  458. }
  459. builder.WriteString(fmt.Sprintf("%s,%s,%s\n", edge.From, edge.To, depType))
  460. }
  461. return builder.String(), nil
  462. }
  463. func findPackage(packages []PackageOutput, path string) *PackageOutput {
  464. for _, pkg := range packages {
  465. if pkg.Path == path {
  466. return &pkg
  467. }
  468. }
  469. return nil
  470. }