├── conf ├── database.ini └── conf.ini ├── .travis.yml ├── conf_test.go ├── README.md ├── conf.go └── LICENSE /conf/database.ini: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: go 3 | 4 | go: 5 | - "1.10" 6 | - "1.9" 7 | - "1.8" 8 | 9 | script: 10 | - go build 11 | - go test -v -cover ./... 12 | -------------------------------------------------------------------------------- /conf/conf.ini: -------------------------------------------------------------------------------- 1 | [database] 2 | username = root 3 | password = dgj99349 4 | hostname = localhost 5 | 6 | [admin] 7 | username = root 8 | password = dgj99349 9 | 10 | [nihao] 11 | username = root 12 | password = dgj99349 -------------------------------------------------------------------------------- /conf_test.go: -------------------------------------------------------------------------------- 1 | package goini 2 | 3 | import ( 4 | "fmt" 5 | "testing" 6 | ) 7 | 8 | func Test(t *testing.T) { 9 | conf := SetConfig("./conf/conf.ini") 10 | username := conf.GetValue("database", "username") 11 | fmt.Println(username) //root 12 | conf.DeleteValue("database", "username") 13 | username = conf.GetValue("database", "username") 14 | if len(username) == 0 { 15 | fmt.Println("username is not exists") //this stdout username is not exists 16 | } 17 | conf.SetValue("database", "username", "widuu") 18 | username = conf.GetValue("database", "username") 19 | fmt.Println(username) //widuu 20 | 21 | data := conf.ReadList() 22 | fmt.Println(data) 23 | } 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | goini 2 | ======== 3 | [![Build Status](https://travis-ci.org/widuu/goini.svg?branch=master)](https://travis-ci.org/widuu/goini) 4 | 5 | **[The official website](http://www.widuu.com)** 6 | ##描述 7 | 8 | 使用goini更简单的读取go的ini配置文件以及根据特定格式的各种配置文件。 9 | 10 | ##安装方法 11 | 12 | gp get github.com/widuu/goini 13 | 14 | ##使用方法 15 | 16 | >ini配置文件格式样列 17 | 18 | [database] 19 | username = root 20 | password = password 21 | hostname = localhost 22 | 23 | [admin] 24 | username = root 25 | password = password 26 | 27 | [nihao] 28 | username = root 29 | password = password 30 | 31 | >初始化 32 | 33 | conf := goini.SetConfig("./conf/conf.ini") //goini.SetConfig(filepath) 其中filepath是你ini 配置文件的所在位置 34 | 35 | >获取单个配置信息 36 | 37 | username := conf.GetValue("database", "username") //database是你的[section]，username是你要获取值的key名称 38 | fmt.Println(username) //root 39 | 40 | >删除一个配置信息 41 | 42 | conf.DeleteValue("database", "username") //username 是你删除的key 43 | username = conf.GetValue("database", "username") 44 | if len(username) == 0 { 45 | fmt.Println("username is not exists") //this stdout username is not exists 46 | } 47 | 48 | >添加一个配置信息 49 | 50 | conf.SetValue("database", "username", "widuu") 51 | username = conf.GetValue("database", "username") 52 | fmt.Println(username) //widuu 添加配置信息如果存在[section]则添加或者修改对应的值，如果不存在则添加section 53 | 54 | >获取所有配置信息 55 | 56 | conf.ReadList() //返回[]map[string]map[string]string的格式 即setion=>key->value 57 | 58 | --- 59 | 60 | goini 61 | ======== 62 | 63 | 64 | ##About 65 | 66 | 使用goini更简单的读取go的ini配置文件以及根据特定格式的各种配置文件。 67 | 68 | ##install 69 | 70 | gp get github.com/widuu/goini 71 | 72 | ##use example 73 | 74 | >conf.ini 75 | 76 | [database] 77 | username = root 78 | password = password 79 | hostname = localhost 80 | 81 | [admin] 82 | username = root 83 | password = password 84 | 85 | [nihao] 86 | username = root 87 | password = password 88 | 89 | >initialize 90 | 91 | conf := goini.SetConfig("./conf/conf.ini") //goini.SetConfig(filepath) filepath = directory+file 92 | 93 | >To obtain a single configuration information 94 | 95 | username := conf.GetValue("database", "username") //username is your key you want get the value 96 | fmt.Println(username) //root 97 | 98 | >To delete a configuration information 99 | 100 | conf.DeleteValue("database", "username") //username is your delete the key 101 | username = conf.GetValue("database", "username") 102 | if len(username) == 0 { 103 | fmt.Println("username is not exists") //this stdout username is not exists 104 | } 105 | 106 | >Add a configuration information 107 | 108 | conf.SetValue("database", "username", "widuu") 109 | username = conf.GetValue("database", "username") 110 | fmt.Println(username) //widuu Adding/section configuration information if there is to add or modify the value of the corresponding, if there is no add section 111 | 112 | >Get all the configuration information 113 | 114 | conf.ReadList() //return []map[string]map[string]string example:setion=>key->value 115 | 116 | 117 | 118 | -------------------------------------------------------------------------------- /conf.go: -------------------------------------------------------------------------------- 1 | /** 2 | * Read the configuration file 3 | * 4 | * @copyright (C) 2014 widuu 5 | * @lastmodify 2014-2-22 6 | * @website http://www.widuu.com 7 | * 8 | */ 9 | 10 | package goini 11 | 12 | import ( 13 | "bufio" 14 | "fmt" 15 | "io" 16 | "os" 17 | "strings" 18 | ) 19 | 20 | type Config struct { 21 | filepath string //your ini file path directory+file 22 | conflist []map[string]map[string]string //configuration information slice 23 | } 24 | 25 | //Create an empty configuration file 26 | func SetConfig(filepath string) *Config { 27 | c := new(Config) 28 | c.filepath = filepath 29 | 30 | return c 31 | } 32 | 33 | //To obtain corresponding value of the key values 34 | func (c *Config) GetValue(section, name string) string { 35 | c.ReadList() 36 | conf := c.ReadList() 37 | for _, v := range conf { 38 | for key, value := range v { 39 | if key == section { 40 | return value[name] 41 | } 42 | } 43 | } 44 | return "no value" 45 | } 46 | 47 | //Set the corresponding value of the key value, if not add, if there is a key change 48 | func (c *Config) SetValue(section, key, value string) bool { 49 | c.ReadList() 50 | data := c.conflist 51 | var ok bool 52 | var index = make(map[int]bool) 53 | var conf = make(map[string]map[string]string) 54 | for i, v := range data { 55 | _, ok = v[section] 56 | index[i] = ok 57 | } 58 | 59 | i, ok := func(m map[int]bool) (i int, v bool) { 60 | for i, v := range m { 61 | if v == true { 62 | return i, true 63 | } 64 | } 65 | return 0, false 66 | }(index) 67 | 68 | if ok { 69 | c.conflist[i][section][key] = value 70 | return true 71 | } else { 72 | conf[section] = make(map[string]string) 73 | conf[section][key] = value 74 | c.conflist = append(c.conflist, conf) 75 | return true 76 | } 77 | 78 | return false 79 | } 80 | 81 | //Delete the corresponding key values 82 | func (c *Config) DeleteValue(section, name string) bool { 83 | c.ReadList() 84 | data := c.conflist 85 | for i, v := range data { 86 | for key, _ := range v { 87 | if key == section { 88 | delete(c.conflist[i][key], name) 89 | return true 90 | } 91 | } 92 | } 93 | return false 94 | } 95 | 96 | //List all the configuration file 97 | func (c *Config) ReadList() []map[string]map[string]string { 98 | 99 | file, err := os.Open(c.filepath) 100 | if err != nil { 101 | CheckErr(err) 102 | } 103 | defer file.Close() 104 | var data map[string]map[string]string 105 | var section string 106 | buf := bufio.NewReader(file) 107 | for { 108 | l, err := buf.ReadString('\n') 109 | line := strings.TrimSpace(l) 110 | if err != nil { 111 | if err != io.EOF { 112 | CheckErr(err) 113 | } 114 | if len(line) == 0 { 115 | break 116 | } 117 | } 118 | switch { 119 | case len(line) == 0: 120 | case string(line[0]) == "#": //增加配置文件备注 121 | case line[0] == '[' && line[len(line)-1] == ']': 122 | section = strings.TrimSpace(line[1 : len(line)-1]) 123 | data = make(map[string]map[string]string) 124 | data[section] = make(map[string]string) 125 | default: 126 | i := strings.IndexAny(line, "=") 127 | if i == -1 { 128 | continue 129 | } 130 | value := strings.TrimSpace(line[i+1 : len(line)]) 131 | data[section][strings.TrimSpace(line[0:i])] = value 132 | if c.uniquappend(section) == true { 133 | c.conflist = append(c.conflist, data) 134 | } 135 | } 136 | 137 | } 138 | 139 | return c.conflist 140 | } 141 | 142 | func CheckErr(err error) string { 143 | if err != nil { 144 | return fmt.Sprintf("Error is :'%s'", err.Error()) 145 | } 146 | return "Notfound this error" 147 | } 148 | 149 | //Ban repeated appended to the slice method 150 | func (c *Config) uniquappend(conf string) bool { 151 | for _, v := range c.conflist { 152 | for k, _ := range v { 153 | if k == conf { 154 | return false 155 | } 156 | } 157 | } 158 | return true 159 | } 160 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, and 10 | distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by the copyright 13 | owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all other entities 16 | that control, are controlled by, or are under common control with that entity. 17 | For the purposes of this definition, "control" means (i) the power, direct or 18 | indirect, to cause the direction or management of such entity, whether by 19 | contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the 20 | outstanding shares, or (iii) beneficial ownership of such entity. 21 | 22 | "You" (or "Your") shall mean an individual or Legal Entity exercising 23 | permissions granted by this License. 24 | 25 | "Source" form shall mean the preferred form for making modifications, including 26 | but not limited to software source code, documentation source, and configuration 27 | files. 28 | 29 | "Object" form shall mean any form resulting from mechanical transformation or 30 | translation of a Source form, including but not limited to compiled object code, 31 | generated documentation, and conversions to other media types. 32 | 33 | "Work" shall mean the work of authorship, whether in Source or Object form, made 34 | available under the License, as indicated by a copyright notice that is included 35 | in or attached to the work (an example is provided in the Appendix below). 36 | 37 | "Derivative Works" shall mean any work, whether in Source or Object form, that 38 | is based on (or derived from) the Work and for which the editorial revisions, 39 | annotations, elaborations, or other modifications represent, as a whole, an 40 | original work of authorship. For the purposes of this License, Derivative Works 41 | shall not include works that remain separable from, or merely link (or bind by 42 | name) to the interfaces of, the Work and Derivative Works thereof. 43 | 44 | "Contribution" shall mean any work of authorship, including the original version 45 | of the Work and any modifications or additions to that Work or Derivative Works 46 | thereof, that is intentionally submitted to Licensor for inclusion in the Work 47 | by the copyright owner or by an individual or Legal Entity authorized to submit 48 | on behalf of the copyright owner. For the purposes of this definition, 49 | "submitted" means any form of electronic, verbal, or written communication sent 50 | to the Licensor or its representatives, including but not limited to 51 | communication on electronic mailing lists, source code control systems, and 52 | issue tracking systems that are managed by, or on behalf of, the Licensor for 53 | the purpose of discussing and improving the Work, but excluding communication 54 | that is conspicuously marked or otherwise designated in writing by the copyright 55 | owner as "Not a Contribution." 56 | 57 | "Contributor" shall mean Licensor and any individual or Legal Entity on behalf 58 | of whom a Contribution has been received by Licensor and subsequently 59 | incorporated within the Work. 60 | 61 | 2. Grant of Copyright License. 62 | 63 | Subject to the terms and conditions of this License, each Contributor hereby 64 | grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 65 | irrevocable copyright license to reproduce, prepare Derivative Works of, 66 | publicly display, publicly perform, sublicense, and distribute the Work and such 67 | Derivative Works in Source or Object form. 68 | 69 | 3. Grant of Patent License. 70 | 71 | Subject to the terms and conditions of this License, each Contributor hereby 72 | grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 73 | irrevocable (except as stated in this section) patent license to make, have 74 | made, use, offer to sell, sell, import, and otherwise transfer the Work, where 75 | such license applies only to those patent claims licensable by such Contributor 76 | that are necessarily infringed by their Contribution(s) alone or by combination 77 | of their Contribution(s) with the Work to which such Contribution(s) was 78 | submitted. If You institute patent litigation against any entity (including a 79 | cross-claim or counterclaim in a lawsuit) alleging that the Work or a 80 | Contribution incorporated within the Work constitutes direct or contributory 81 | patent infringement, then any patent licenses granted to You under this License 82 | for that Work shall terminate as of the date such litigation is filed. 83 | 84 | 4. Redistribution. 85 | 86 | You may reproduce and distribute copies of the Work or Derivative Works thereof 87 | in any medium, with or without modifications, and in Source or Object form, 88 | provided that You meet the following conditions: 89 | 90 | You must give any other recipients of the Work or Derivative Works a copy of 91 | this License; and 92 | You must cause any modified files to carry prominent notices stating that You 93 | changed the files; and 94 | You must retain, in the Source form of any Derivative Works that You distribute, 95 | all copyright, patent, trademark, and attribution notices from the Source form 96 | of the Work, excluding those notices that do not pertain to any part of the 97 | Derivative Works; and 98 | If the Work includes a "NOTICE" text file as part of its distribution, then any 99 | Derivative Works that You distribute must include a readable copy of the 100 | attribution notices contained within such NOTICE file, excluding those notices 101 | that do not pertain to any part of the Derivative Works, in at least one of the 102 | following places: within a NOTICE text file distributed as part of the 103 | Derivative Works; within the Source form or documentation, if provided along 104 | with the Derivative Works; or, within a display generated by the Derivative 105 | Works, if and wherever such third-party notices normally appear. The contents of 106 | the NOTICE file are for informational purposes only and do not modify the 107 | License. You may add Your own attribution notices within Derivative Works that 108 | You distribute, alongside or as an addendum to the NOTICE text from the Work, 109 | provided that such additional attribution notices cannot be construed as 110 | modifying the License. 111 | You may add Your own copyright statement to Your modifications and may provide 112 | additional or different license terms and conditions for use, reproduction, or 113 | distribution of Your modifications, or for any such Derivative Works as a whole, 114 | provided Your use, reproduction, and distribution of the Work otherwise complies 115 | with the conditions stated in this License. 116 | 117 | 5. Submission of Contributions. 118 | 119 | Unless You explicitly state otherwise, any Contribution intentionally submitted 120 | for inclusion in the Work by You to the Licensor shall be under the terms and 121 | conditions of this License, without any additional terms or conditions. 122 | Notwithstanding the above, nothing herein shall supersede or modify the terms of 123 | any separate license agreement you may have executed with Licensor regarding 124 | such Contributions. 125 | 126 | 6. Trademarks. 127 | 128 | This License does not grant permission to use the trade names, trademarks, 129 | service marks, or product names of the Licensor, except as required for 130 | reasonable and customary use in describing the origin of the Work and 131 | reproducing the content of the NOTICE file. 132 | 133 | 7. Disclaimer of Warranty. 134 | 135 | Unless required by applicable law or agreed to in writing, Licensor provides the 136 | Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, 137 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, 138 | including, without limitation, any warranties or conditions of TITLE, 139 | NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are 140 | solely responsible for determining the appropriateness of using or 141 | redistributing the Work and assume any risks associated with Your exercise of 142 | permissions under this License. 143 | 144 | 8. Limitation of Liability. 145 | 146 | In no event and under no legal theory, whether in tort (including negligence), 147 | contract, or otherwise, unless required by applicable law (such as deliberate 148 | and grossly negligent acts) or agreed to in writing, shall any Contributor be 149 | liable to You for damages, including any direct, indirect, special, incidental, 150 | or consequential damages of any character arising as a result of this License or 151 | out of the use or inability to use the Work (including but not limited to 152 | damages for loss of goodwill, work stoppage, computer failure or malfunction, or 153 | any and all other commercial damages or losses), even if such Contributor has 154 | been advised of the possibility of such damages. 155 | 156 | 9. Accepting Warranty or Additional Liability. 157 | 158 | While redistributing the Work or Derivative Works thereof, You may choose to 159 | offer, and charge a fee for, acceptance of support, warranty, indemnity, or 160 | other liability obligations and/or rights consistent with this License. However, 161 | in accepting such obligations, You may act only on Your own behalf and on Your 162 | sole responsibility, not on behalf of any other Contributor, and only if You 163 | agree to indemnify, defend, and hold each Contributor harmless for any liability 164 | incurred by, or claims asserted against, such Contributor by reason of your 165 | accepting any such warranty or additional liability. 166 | 167 | END OF TERMS AND CONDITIONS 168 | 169 | APPENDIX: How to apply the Apache License to your work 170 | 171 | To apply the Apache License to your work, attach the following boilerplate 172 | notice, with the fields enclosed by brackets "[]" replaced with your own 173 | identifying information. (Don't include the brackets!) The text should be 174 | enclosed in the appropriate comment syntax for the file format. We also 175 | recommend that a file or class name and description of purpose be included on 176 | the same "printed page" as the copyright notice for easier identification within 177 | third-party archives. 178 | 179 | Copyright [yyyy] [name of copyright owner] 180 | 181 | Licensed under the Apache License, Version 2.0 (the "License"); 182 | you may not use this file except in compliance with the License. 183 | You may obtain a copy of the License at 184 | 185 | http://www.apache.org/licenses/LICENSE-2.0 186 | 187 | Unless required by applicable law or agreed to in writing, software 188 | distributed under the License is distributed on an "AS IS" BASIS, 189 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 190 | See the License for the specific language governing permissions and 191 | limitations under the License. --------------------------------------------------------------------------------