开源项目 `orderedmap` 使用教程

开源项目 orderedmap 使用教程

orderedmaporderedmap is a golang map where the keys keep the order that they're added. It can be de/serialized from/to JSON. It's based closely on the python collections.OrderedDict.项目地址:https://gitcode.com/gh_mirrors/ord/orderedmap

1. 项目的目录结构及介绍

orderedmap 项目的目录结构相对简单，主要包含以下文件和目录：

orderedmap/
├── .github/
│   └── workflows/
│       └── ...
├── .editorconfig
├── .gitignore
├── LICENSE
├── README.md
├── go.mod
├── go.sum
├── list.go
├── orderedmap.go
└── orderedmap_test.go

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• go.mod: Go 模块文件，定义项目依赖。
• go.sum: Go 模块校验文件。
• list.go: 列表相关实现文件。
• orderedmap.go: 有序映射的主要实现文件。
• orderedmap_test.go: 有序映射的测试文件。

2. 项目的启动文件介绍

orderedmap 项目的主要启动文件是 orderedmap.go。该文件定义了 OrderedMap 类型及其相关方法，包括设置、获取、删除键值对等操作。以下是 orderedmap.go 的部分代码示例：

package orderedmap

import (
	"encoding/json"
	"sort"
)

type OrderedMap struct {
	keys []string
	mp   map[string]interface{}
}

func NewOrderedMap() *OrderedMap {
	return &OrderedMap{
		keys: []string{},
		mp:   make(map[string]interface{}),
	}
}

func (o *OrderedMap) Set(key string, value interface{}) {
	if _, exists := o.mp[key]; !exists {
		o.keys = append(o.keys, key)
	}
	o.mp[key] = value
}

func (o *OrderedMap) Get(key string) (interface{}, bool) {
	val, exists := o.mp[key]
	return val, exists
}

func (o *OrderedMap) Delete(key string) {
	delete(o.mp, key)
	for i, k := range o.keys {
		if k == key {
			o.keys = append(o.keys[:i], o.keys[i+1:]...)
			break
		}
	}
}

3. 项目的配置文件介绍

orderedmap 项目没有专门的配置文件，其依赖和模块信息主要通过 go.mod 和 go.sum 文件进行管理。以下是 go.mod 文件的内容示例：

module github.com/iancoleman/orderedmap

go 1.16

require (
	github.com/stretchr/testify v1.7.0
)

• module: 定义了模块路径。
• go: 指定 Go 版本。
• require: 列出了项目依赖的其他模块及其版本。

通过这些文件，可以确保项目在不同环境中的一致性和可重复构建。

orderedmaporderedmap is a golang map where the keys keep the order that they're added. It can be de/serialized from/to JSON. It's based closely on the python collections.OrderedDict.项目地址:https://gitcode.com/gh_mirrors/ord/orderedmap