CLI 命令行实用程序开发实战 - Agenda

最新推荐文章于 2022-03-19 00:01:56 发布
最新推荐文章于 2022-03-19 00:01:56 发布
阅读量283 收藏
点赞数
分类专栏： 服务计算
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/LLL_Sicily/article/details/102913483
版权

目录

项目介绍

参考资料：https://www.cnblogs.com/welhzh/p/8962489.html

开发环境

安装和使用cobra

安装cobra

打开vsc的终端，转到gopath路径（我的是 C:\Users\LLL\go）里面，输入命令安装cobra：

go get -v github.com/spf13/cobra/cobra

https://blog.csdn.net/snowin1994/article/details/88358836

下载过程中发生了以下错误：
在这里插入图片描述
参考了老师所给教程和另一个博客中所给的提示，先到$GOPATH/src/golang.org/x目录下用 git clone 下载 sys 和 text 项目
具体指令为：

mkdir $GOPATH/src/golang.org/x  //创建文件夹
cd $GOPATH/src/golang.org/x  //转至该文件夹
git clone https://github.com/golang/text
git clone https://github.com/golang/sys

改错
发现windows下环境变量有问题，
在这里插入图片描述
所以将后两个命令改为

mkdir C:\Users\LLL\go/src/golang.org/x 
cd C:\Users\LLL\go/src/golang.org/x

之后便可按原命令go get -v github.com/spf13/cobra/cobra下载。

下载成功后使用命令生成cobra可执行文件

go install github.com/spf13/cobra/cobra

此时，就以安装成功了，查看bin文件夹，可在下面发现已经生成cobra.exe：
在这里插入图片描述

Cobra 的使用

创建一个处理命令 agenda register -uTestUser 或 agenda register --user=TestUser 的小程序。
首先进入src文件夹，用cobra init新建一个demo（cobra只能够在gopath的目录下使用）：

cobra init demo --pkg-name=demo

在这里插入图片描述

进入生成的demo文件夹，使用命令来增加register命令：

cobra add register

在这里插入图片描述
之后便产生了需要的文件：
在这里插入图片描述

修改register.go

阅读【main.go】和【root.go】、【register.go】三个文件可得知,然后我们可以通过修改【register.go】来添加相应的操作:

  • init() 函数:
    registerCmd.Flags().StringP("user", "u", "Anonymous", "Help message for username")1
  • Run 匿名回调函数：
    username, _ := cmd.Flags().GetString("user")fmt.Println("register called by " + username)

测试命令

使用以下命令测试：

go run main.go register --user=TestUser
register called by TestUser？？

出现register被调用的输出，结果正确：
在这里插入图片描述

Agenda 开发项目

Agenda项目目录

cmd ：存放命令实现代码
entity ：存放 User 对象读写与处理逻辑
data ： 存储User信息和生成log
service：存放命令实现代码所需借用的功能函数
loghelper：存放实现log的相关代码
deepcopy：存放复制功能代码

实现指令

要求

实现2条指令即可，不需要协作。
之前已实现register用户注册指令，这里实现的是login和logout指令。

  • 用户注册
    注册新用户时，用户需设置一个唯一的用户名和一个密码。另外，还需登记邮箱及电话信息。
    如果注册时提供的用户名已由其他用户使用，应反馈一个适当的出错信息；成功注册后，亦应反馈一个成功注册的信息。

  • 用户登录
    用户使用用户名和密码登录 Agenda 系统。
    用户名和密码同时正确则登录成功并反馈一个成功登录的信息。否则，登录失败并反馈一个失败登录的信息。

  • 用户登出
    已登录的用户登出系统后，只能使用用户注册和用户登录功能。

添加命令

使用命令

cobra add login
cobra add logout

在这里插入图片描述

用户注册

绑定参数：

register a new user, a unique username, a password, an email and a phone required

Usage:
  Agenda register [flags]

Flags:
  -c, --contact string    phone number
  -e, --email string      email address
  -h, --help              help for register
  -p, --password string   password
  -u, --username string   username

register.go如下：

package entity

import (
	"os"
	"io"
	"bufio"
	"path/filepath"
	"errors"
	"log"
	"encoding/json"
	"demo/loghelper"
	"demo/deepcopy"
)

type UserFilter func (*User) bool

var userinfoPath = "/src/demo/data/userinfo"
var curUserPath = "/src/demo/data/curuser.txt"

var curUserName *string
var dirty bool
var uData []User
var errLog *log.Logger

func init()  {
	errLog = loghelp.Error
	dirty = false
	userinfoPath  = filepath.Join(loghelp.GoPath, userinfoPath)
	curUserPath = filepath.Join(loghelp.GoPath, curUserPath)
	if err := readFromFile(); err != nil {
		errLog.Println("readFromFile fail: ",err)
	}
}

func Sync() error {
	if err := writeToFile(); err != nil {
		errLog.Println("writeToFile fail: ",err)
		return err
	}
	return nil
}
func CreateUser(v *User)  {
	uData = append(uData, deepcopy.Copy(*v).(User))
	dirty = true
}
func QueryUser(filter UserFilter)  []User{
	var user []User
	for _, v := range uData {
		if filter(&v) {
			user = append(user,v)
		}
	}
	return user
}

func SetCurUser(u *User)  {
	if u == nil {
		curUserName = nil
		return
	}
	if curUserName == nil {
		p := u.Name
		curUserName = &p
	} else {
		*curUserName = u.Name
	}
}

//return current user
func GetCurUser() (User, error) {
	if curUserName == nil {
		return User{}, errors.New("Current user doesn't exist")
	}
	for _, v := range uData {
		if v.Name == *curUserName {
			return v, nil
		}
	}
	return User{}, errors.New("Current user doesn't exist")
}

func Logout() error {
	curUserName = nil
	return Sync()
}
func readFromFile() error {
	var e []error
	str, err1 := readString(curUserPath)
	if err1 != nil {
		e = append(e, err1)
	}
	curUserName = str
	if err := readUser(); err != nil {
		e = append(e, err)
	}
	//if err := readMet(); err != nil {
	//	e = append(e, err)
	//}
	if len(e) == 0 {
		return nil
	}
	er := e[0]
	for i := 1; i < len(e); i++ {
		er = errors.New(er.Error() + e[i].Error())
	}
	return er
}

// writeToFile : write file content from memory
// @return if fail, error will be returned
func writeToFile() error {
	var e []error
	if err := writeString(curUserPath, curUserName); err != nil {
		e = append(e, err)
	}
	if dirty {
		if err := writeJSON(userinfoPath, uData); err != nil {
			e = append(e, err)
		}
		//if err := writeJSON(metinfoPath, mData); err != nil {
		//	e = append(e, err)
		//}
	}
	if len(e) == 0 {
		return nil
	}
	er := e[0]
	for i := 1; i < len(e); i++ {
		er = errors.New(er.Error() + e[i].Error())
	}
	return er
}

func readUser() error {
	file, err := os.Open(userinfoPath);
	if err != nil {
		errLog.Println("Open File Fail:", userinfoPath, err)
		return err
	}
	defer file.Close()

	dec := json.NewDecoder(file)
	switch err := dec.Decode(&uData); err {
	case nil, io.EOF:
		return nil
	default:
		errLog.Println("Decode User Fail:", err)
		return err
	}
}

/*
func readMet() error {
	file, err := os.Open(metinfoPath);
	if err != nil {
		errLog.Println("Open File Fail:", metinfoPath, err)
		return err
	}
	defer file.Close()

	dec := json.NewDecoder(file)
	switch err := dec.Decode(&mData); err {
	case nil, io.EOF:
		return nil
	default:
		errLog.Println("Decode Met Fail:", err)
		return err
	}
}
*/

func writeJSON(fpath string, data interface{}) error {
	file, err := os.Create(fpath);
	if err != nil {
		return err
	}
	defer file.Close()

	enc := json.NewEncoder(file)

	if err := enc.Encode(&data); err != nil {
		errLog.Println("writeJSON:", err)
		return err
	}
	return nil
}

func writeString(path string, data *string) error {
	file, err := os.Create(path)
	if err != nil {
		loghelp.Error.Println("Create file error:", path)
		return err
	}
	defer file.Close()

	writer := bufio.NewWriter(file)
	if data != nil {
		if _, err := writer.WriteString(*data); err != nil {
			loghelp.Error.Println("Write file fail:", path)
			return err
		}
	}
	if err := writer.Flush(); err != nil {
		loghelp.Error.Println("Flush file fail:", path)
		return err
	}
	return nil
}

func readString(path string) (*string, error) {
	file, err := os.Open(path)
	if err != nil {
		loghelp.Error.Println("Open file error:", path)
		return nil, err
	}
	defer file.Close()

	reader := bufio.NewReader(file)
	str, err := reader.ReadString('\n');
	if err != nil && err != io.EOF {
		loghelp.Error.Println("Read file fail:", path)
		return nil, err
	}
	return &str, nil
}

用户登录

用命令login -u -p来实现用户登录功能。
login.go如下：

/*
Copyright ? 2019 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package cmd

import (
	"fmt"
	"demo/service"
	"github.com/spf13/cobra"
)

var (
	username *string
	password *string
)
// loginCmd represents the login command
var loginCmd = &cobra.Command{
	Use:   "login",
	Short: "For User To Login",
	Run: func(cmd *cobra.Command, args []string) {
		tmpu, _ := cmd.Flags().GetString("username")
		tmppw, _ := cmd.Flags().GetString("password")

		if tmpu == "" || tmppw == "" {
			fmt.Println("Input the username[-u],password[-p]")
			return;
		}
		if _, flag := service.GetCurUser(); flag == true {
			fmt.Println("Please logout firstly")
			return
		}
		if tf := service.UserLogin(tmpu,tmppw); tf == true {
			fmt.Println("Login Successfully!")
		} else {
			fmt.Println("Login Fail: wront username or password")
		}
		return
	},
}

func init() {
	rootCmd.AddCommand(loginCmd)
	loginCmd.Flags().StringP("username","u","","agenda account username")
	loginCmd.Flags().StringP("password","p","","agenda account password")
}

用户登出

logout.go如下：

/*
Copyright ? 2019 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package cmd

import (
	"fmt"
	"demo/service"
	"github.com/spf13/cobra"
)

// logoutCmd represents the logout command
var logoutCmd = &cobra.Command{
	Use:   "logout",
	Short: "For User To Logout",
	Run: func(cmd *cobra.Command, args []string) {
		if err := service.UserLogout(); err != true {
			fmt.Println("Error happened, please check the error log")
		} else {
			fmt.Println("Logout Successfully!")
		}
	},
}

func init() {
	rootCmd.AddCommand(logoutCmd)
}

service中的函数

service.go如下：

package service

import (
	"demo/entity"
	"demo/loghelper"
	"log"
)

var curuserinfo = "/src/demo/data/curuser.txt"
var errLog *log.Logger
type User entity.User

func  init()  {
	errLog = loghelp.Error
}

func GetCurUser() (entity.User, bool) {
	if cu, err := entity.GetCurUser(); err != nil {
		return cu, false
	} else {
		return cu, true
	}
}
//Regist
func UserRegister(username string, password string,  email string, phone string) (bool, error)  {
	user := entity.QueryUser(func (u *entity.User) bool {
		return u.Name == username
	})
	if len(user) == 1 {
		errLog.Println("User Register: username already exists")
		return false, nil
	}
	entity.CreateUser(&entity.User{username,password,email,phone})
	if err := entity.Sync(); err != nil {
		return true, err
	}
	return true, nil
}

//Login
func UserLogin(username, password string) bool  {
	user := entity.QueryUser(func (u *entity.User) bool {
		if u.Name == username && u.Password == password {
			return true
		}
		return false
	})
	if len(user) == 0 {
		errLog.Println("Login: User not exist")
		return false
	}
	entity.SetCurUser(&user[0])
	if err := entity.Sync(); err != nil {
		errLog.Println("Login: error happened when set curuser")
		return false
	}
	return true
}

//Logout
func UserLogout() bool {
	if err := entity.Logout(); err != nil {
		return false
	} else {
		return true
	}
}

运行结果

创建新用户：
在这里插入图片描述
当创建新用户时用了重复的用户名时报错：
在这里插入图片描述
用户登录：
在这里插入图片描述
重复登录报错：
在这里插入图片描述
用户密码错误报错：
在这里插入图片描述
登出：
在这里插入图片描述

完整代码

请见我的GitHub

LLL_Sicily
关注
专栏目录
golang -- CLI 命令行实用程序开发实战 - Agenda
agent0024的博客
10-22 512
一、环境配置 Cobra既是用于创建强大的现代CLI应用程序的库，也是用于生成应用程序和命令文件的程序。程序选择Cobra进行命令行的解析，以下配置基于Ubuntu16.04 Cobra安装 直接使用命令go get -v github.com/spf13/cobra/cobra下载会出现错误，首先需要安装golang的项目依赖test和sys 首先cd到$GOPATH/src/gol...
CLI 命令行实用程序开发基础
MADAYEI的博客
10-06 2205
CLI 命令行实用程序开发基础 概述 CLI（Command Line Interface）实用程序是Linux下应用开发的基础。正确的编写命令行程序让应用与操作系统融为一体，通过shell或script使得应用获得最大的灵活性与开发效率。Linux提供了cat、ls、copy等命令与操作系统交互；go语言提供一组实用程序完成从编码、编译、库管理、产品发布全过程支持；容器服务如docker、k8s...
配置go的gocode,guru,godef
qq_38019655的博客
01-15 5734
配置go的gocode,guru,godef 一、配置gocode go get -u -v github.com/nsf/gocode 默认下载的地址为:C:\Users\Administrator\go 二、配置godef go get -u -v github.com/rogpeppe/godef 默认下载的地址为:C:\Users\Administrator\go 三、配置guru g...
使用国内源下载git 并使用git解决golang上不去导致的一系列问题
kaowayaaaaa的博客
09-27 1583
下载git git官网地址 https://git-scm.com/downloads 但是实在太慢了，遂选择阿里源 https://npm.taobao.org/mirrors/git-for-windows/ 进去之后选择版本，rc是预览版，没写rc的是发布版 安装git 解决问题 按照这篇 解决 VS Code 中 golang.org 被墙导致的 Go 插件安装失败问题 ...
CLI (命令行接口) 简易开发
wabil的专栏
04-25 7995
CLI (Command Line Interface) 命令行接口,是底层操作系统必备的工具, 其实它的思路不复杂, 定义一个全局的数组定义整个系统的命令集合, 然后通过注册CLI,撤销CLI等操作对全局数据.在用户入口处加一监听线程, 然后历遍分析输入的数据是否需要属于系统指令. void help_cmd(char *inBuf,int i){ } void ver_c
windows 系统 vscode中 go 插件安装失败的解决方法 2021/3/6
人言落日是天涯，望极天涯不见家。
03-06 1236
1.运行 go env -w GO111MODULE=on //开启mod 运行 go env -w GOPROXY=https://goproxy.cn,direct //设置代理 2.进入GOPATH目录,创建src/golang.org/x/目录,进入src/golang.org/x/目录 git clone https://github.com/golang/tools.git git clone https://github.
服务计算|CLI命令行使用程序开发实战-Agenda
qq_40328334的博客
11-06 263
一、环境配置 Cobra既是用于创建强大的现代CLI应用程序的库，也是用于生成应用程序和命令文件的程序。程序选择Cobra进行命令行的解析，以下配置基于Ubuntu16.04 直接使用命令go get -v github.com/spf13/cobra/cobra下载会出现错误，首先需要安装golang的项目依赖test和sys 首先cd到$GOPATH/src/gola...
org-agenda-carlos:卡洛斯为GTD定制组织议程
04-01
议程组织卡洛斯 ...（setq org-agenda-custom-commands（附加org-agenda-custom-commands org-agenda-custom-commands）） 快速捕捉笔记 (setq org-capture-templates '( ("ll" "Leju 日常" entry (file+datet
idle-org-agenda：一个软件包，在Emacs空闲时显示您的议程
02-05
2. 将下载的 `idle-org-agenda-master` 文件夹移动到 `.emacs.d/elpa` 目录下，或者将其克隆到 Git 工作流中。 3. 在 Emacs 的配置文件 `.emacs` 或 `.emacs.d/init.el` 中添加插件的启用代码，例如 `(require 'idle...
VS Code配置Go语言开发环境
weixin_30470643的博客
09-13 145
目录 一、VS Code配置Go语言开发环境 二、下载与安装 三、安装中文简体插件 四、安装Go开发扩展 五、变更编辑器主题 六、安装Go语言开发工具包 6.1 方法一：使用git下载源代码再安装 6.2 方法二：下载已经编...
借助码云快速安装 golang.org/x/lint/golint 和 golang.org/x/tools/ 等依赖
Myth的博客
10-20 6803
GO基本开发环境搭建 入门时使用VSCode是比较方便的, VSCode 会推荐我们安装如下工具 tools 工具集 guru golang.org/x/tools/cmd/guru gorename golang.org/x/tools/cmd/gorename lint golang.org/x/lint golint golang.org/x/lint/golint ...
解决golang.org/x包无法下载的问题
kangyunqiang的专栏
10-30 6792
由于Google相关的包无法直接下载，可以使用如果方式下载下来，然后创建软连接或者修改文件夹名称来解决： 第一步： git clone https://github.com/golang/net.git $GOPATH/src/github.com/golang/net git clone https://github.com/golang/sys.git $GOPATH/src/gi
Git Clone 报错 fatal: unable to access ‘https://github.com/golang/tools.git/‘: LibreSSL SSL_connect...
03-19 704
Git Clone 报错 fatal: unable to access 'https://github.com/golang/tools.git/': LibreSSL SSL_connect...
c语言cli添加命令示例,CLI 命令行实用程序开发基础
weixin_35299004的博客
05-24 1346
服务计算概述CLI(Command Line Interface)实用程序是Linux下应用开发的基础。正确的编写命令行程序让应用与操作系统融为一体，通过shell或script使得应用获得最大的灵活性与开发效率。例如：Linux提供了cat、ls、copy等命令与操作系统交互；go语言提供一组实用程序完成从编码、编译、库管理、产品发布全过程支持；容器服务如docker、k8s提供了大量实用程序支...
go 获取golang.org/x/tools包
热门推荐
云淡风轻
10-25 2万+
go 获取golang.org/x/tools包，由于墙得原因，设置代理也不成功，提示如下 go get golang.org/x/tools/go/packages package golang.org/x/tools/go/packages: unrecognized import path "golang.org/x/tools/go/packages" (https fetch: Get...
Go学习笔记：关于golang.org/x包问题
无香花自开
05-11 9874
关于golang.org/x包问题由于谷歌被墙
Drools5开发教程：从环境搭建到实战
" Drools5 开发教程是一个详细介绍如何使用 Drools 5 版本的教程，适合初学者。教程作者为高杰，由上海锐道信息技术有限公司发布。内容包括学习前的准备，如安装 JDK 和搭建开发环境，特别是如何下载与安装 Drools5 ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值