书店管理系统开发文档

作者：房诗涵

程序功能概述

一个书店管理系统，允许用命令行以合法指令交互。

系统包括：账户系统、图书系统、日志系统。

交互方式

各个系统通过系统对应的合法指令操作。

输入数据以换行符或回车符为分隔为若干指令。

单个合法指令由ASCII 字符、空格（多个连续空格效果与一个空格等价；行首行末允许出现多余空格；如无特殊说明禁止省略或另增空格）构成。

指令中第一个部分必须为指令关键词，指令中关键词部分必须与指令格式完全匹配。

在用户输入一条指令后，如果合法则执行对应操作，如果有则输出操作结果；如果指令非法或操作失败则输出Invalid\ 。仅有空格的指令合法且无输出内容。

除非有特殊说明，如果输入指令对应的输出内容非空，则结尾有 \n 字符；输出内容为空则不输出任何字符。

合法指令要求：

[x] 表示一串有特定限制的用户自定义字符串；
(a|b|c) 表示此处仅能出现a,b,c中其一；
(x)? 表示此处可以出现零次或一次 x；
(x)+ 表示此处可以出现一次或多次 x。

指令包括：

基础指令 quit正常退出系统 exit 正常退出系统
帐户系统指令 su [UserID] ([Password])? logout register [UserID] [Password] [Username] passwd [UserID] ([CurrentPassword])? [NewPassword] useradd [UserID] [Password] [Privilege] [Username] delete [UserID]
图书系统指令 show (-ISBN=[ISBN] | -name="[BookName]" | -author="[Author]" | -keyword="[Keyword]")? buy [ISBN] [Quantity] select [ISBN] modify (-ISBN=[ISBN] | -name="[BookName]" | -author="[Author]" | -keyword="[Keyword]" | -price=[Price])+ import [Quantity] [TotalCost]
日志系统指令 show finance ([Count])? log

系统功能

账户系统

书店管理系统服务于店主（超级管理员），员工（管理员）以及顾客（用户）。

为满足其不同需求，故需帐户系统管理帐户及权限数据，并提供相应功能。

图书系统

图书系统提供图书信息、库存信息和图书交易财务记录的相关服务及数据存储功能。

日志系统

日志系统负责记录书店管理系统运行过程中的各种数据，提供各类日志信息查询服务

主体逻辑说明

在main函数中通过循环读入指令，main基本不进行具体指令执行，除基础指令quit和 exit。
利用tokenscanner读入指令，然后利用parser解析指令。若指令非法，抛出异常。
解析后的指令由不同的类进行具体操作。
通过文件读写来实现数据的输入输出。

代码文件结构

主函数: main.cpp

类：

账户类：account.h / account.cpp
登录状态类：loggingStatus.h / loggingStatus.cpp
图书类：book.h / book.cpp
日志类：log.h / log.cpp
块状链表类：linkList.h / linkList.cpp
指令扫描解析类：tokenparser.h/tokenparser.cpp
异常处理类：error.h/error.cpp

文件：

账户信息相关文件
登录状态相关文件（和操作日志重复？）
图书信息文件
日志文件：财务日志文件、操作日志文件

各个类的接口及成员说明

账户

AccountManager类

//单个账户
//作为块状链表accontList的BlockNode的元素
struct account {
  int privilege;
    
  char ID [31], name[31];
    
  char password[31];
  
  //修改密码
  void ChangePassword(std::string &CurrentPassword,std::string &NewPassword);
};

class AccountManager {
public:  
  //注册账户 {0} register [UserID] [Password] [Username]
  void Register(std::string &UserID,std::string &Password,std::string & Username);
    
  //创建帐户 {3} useradd [UserID] [Password] [Privilege] [Username]
  void AddUser(std::string &UserID, std::string &Password,int Privilege ,std::string & Username);
    
  //删除账户 {7} delete [UserID] 
  void DeleteUser(std::string &UserID)
      
  //修改密码 {1} passwd [UserID] ([CurrentPassword])? [NewPassword]
  void ChangePassword(std::sting&UserID,std::string&CurrentPassword,std::strin&NewPassword);

private:
  //储存账户信息的块状链表
  LinkList accountList;
    
  //由ID到index的映射，用于块状链表元素的查找、插入、删去，判断ID是否合法等操作
  unordered_map<std::string,int> indexList;
  
  fstream io_account_information;
  
  fstream io_account_index;
  
  //查找帐户 
  Account FindAccount(std::string UserID);
}

登录状态

LoggingStatus类

class LoggingStatus {
public：
  //登录账户 {0} su [UserID] ([Password])?
  void Login(std::string &UserID, std::string &Password); 
    
  //登出账户 logout
  void Logout();
  
  //账户选择图书
  void Select(std::string);

private:
  //登录栈 记录登录的账户 后进先出
  std::stack<account> logging;
  
  //最后一个登录者（即接下来行为的执行者）
  account currentAccount;
}

图书

BookManager类

struct book {
  //合法字符集：除不可见字符以外 ASCII 字符
  char ISBN[21]; 
    
  char name[61];
    
  char author[61];
    
  char keyword[61]; //内容以 | 为分隔可以出现多段信息
    
  int quantity; //数值不超过 2'147'483'647
    
  double price; //浮点数输入输出精度固定为小数点后两位
    
  double totalCost; //浮点数输入输出精度固定为小数点后两位
};

class BookManager {
public:
  //购买图书 buy [ISBN] [Quantity]
  void Buy(std::string &ISBN,int Quantity);
    
  //选择图书 {3} select [ISBN]
  void Select(std::string &ISBN);
    
  //修改图书信息 {3} modify (-ISBN=[ISBN] | -name="[BookName]" | -author="[Author]" | -keyword="[Keyword]" | -price=[Price])+
  void ChangeInformation(std::string &ISBN, std::string & BookName, std::string & Author,std::string Keyword,double Price);
    
  //图书进货 {3} import [Quantity] [TotalCost]
  void Inport(std::string &ISBN,int Quantity,int TotalCost);

private:
  //储存图书信息的块状链表
  LinkList bookList;
    
  //由ISBN到index的映射，用于块状链表元素的查找、插入、删去等操作
  unordered_map<std::string,int> indexList;
  
  fstream io_book_information;
  
  fstream io_book_index;
  
  //查找图书
  FindBook(std::string ISBN);
};

日志

Log类

#include<fstream>

//一条操作记录
struct record{
  std::string UserID;
    
  std::string command;
 }
class Log{
public:
  //财务记录查询：
  void ShowFinance(int count);
  
  //显示日志记录
  void ShowLog();
  
  //添加一条财务记录
  void AddFinanceLog(std::string)

  //添加一条日志记录
  void Addlog(std::string)

private:
  int count;

  long long sum;
  
  //读写财务日志
  fstream io_finance_log;
  
  //读写日志
  fstream io_log;
};

块状链表

LinkList类

说明：辅助信息存取,用于账户信息、图书信息的维护。

#ifndef BOOKSTORE_LINKLIST_H
#define BOOKSTORE_LINKLIST_H

#include <fstream>

template<class key,class someType>//Array 类型
class LinkList {

public:
    //构造函数
    //file_name:文件名
    //typeSize：someType占空间(byte)大小,由此决定block_size
    //1.将LinkList与对应的文件和someType大小关联
    //2.构造list头节点，写入文件
    LinkList(const std::string &file_name, int typeSize);

    ~LinkList();

    //插入元素
    void Insert(key key1, const someType &ele);

    //删去元素
    void Erase(key key1);

    //寻找元素
    someType FindKey(key key1);

private:
    //a node in LinkList
    struct BlockNode {
        //链接
        long pre = 0;
        long next = 0;

        //块状链表基础参数
        int size = 0;//元素个数
        key max ;//区间上界
        key min ;//区间下界
        static int block_size;

        //储存内容
        someType Array[block_size];

        //返回找到的ele
        someType Find(key key1);

        //向BlockNode的Array插入一个元素
        //需要裂块 返回true
        bool Insert(key key1, const someType &ele);

        //从BlockNode的Array删除一个元素
        bool Erase(key key1);
    };

    //empty head
    struct HeadNode {
        long pre;
        long next;
    };

    long head, rear;

    //LinkList读写的文件流对象 在LinkList构造时和相关文件关联
    std::fstream r_w_LinkList;

    //返回iter指向节点
    BlockNode ReadNode(long iter);

    //修改blockNode信息，覆盖原信息
    void WriteNode(const BlockNode &blockNode, const long &iter);

    //返回index所在的node
    BlockNode FindNode(key key1, long &iter);

    //在文件末开一个新node
    long GetNode();

    //裂块
    void BreakNode(const long &iter, BlockNode &blockNode);

    //并块
    void CombineNode(const long &iter, BlockNode &blockNode1,BlockNode &blockNode2);
};

#endif //BOOKSTORE_LINKLIST_H

指令扫描解析

TokenParser类

（parse部分急需补充）

class TokenParser {
public:
  //构造一个扫描解释器 将以空格隔开的指令分割为token(string) 分辨指令类型
  TokenParser();
  
  //将string设置为扫描输入
  void SetInput(std::string);
    
  //判断是否扫描完毕
  bool HasMoreTokens();
    
  //获取下一个token
  std::string nextToken();
  
private:
  //待扫描指令
  std::string input;
    
  //当前扫描位置
  int currentPos=0;
    
  //是否开始扫描（是否跳完空格）
  bool start=false;
    
  bool scanStringFlag;
  bool scanIntFlag;     
  bool scanDoubleFlag;
  
  //处理前导空格
  void SkipSpaces();
    
  //string
  std::string ScanString();
    
  //int
  int ScanInt();
    
  //double
  double ScanDouble();
}

异常处理

ErrorException类

class ErrorException : public std::exception {
public:
    explicit ErrorException(std::string message);

    std::string getMessage() const;

private:
    std::string message;
};

  //调用以throw
  void error(std::string message);

文件存储说明

使用二进制文件储存信息。
所有信息使用块状链表存在文件中，链表的结点大小设计将尽量提高对读写信息的利用效率。

账户信息相关文件

account_information：账户全部基础信息（块状链表）
account_index：账户ID到index的映射结果（类似map）

图书信息文件

book_information：图书全部基础信息
book_ISBN_index：图书ISBN到index的映射结果
book_name_index：图书name到index的映射结果
book_author_index：图书author到index的映射结果
book_keyword_index：图书keyword到index的映射结果

日志文件

finance_log：财务日志文件
log：操作日志文件

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

书店管理系统开发文档

程序功能概述

交互方式

系统功能

账户系统

相关说明

图书系统

相关说明

日志系统

相关说明

主体逻辑说明

代码文件结构

各个类的接口及成员说明

账户

登录状态

图书

日志

块状链表

指令扫描解析

异常处理

文件存储说明

账户信息相关文件

图书信息文件

日志文件

其他补充说明

FilesExpand file tree

docs.md

Latest commit

History

docs.md

File metadata and controls

书店管理系统开发文档

程序功能概述

交互方式

系统功能

账户系统

相关说明

图书系统

相关说明

日志系统

相关说明

主体逻辑说明

代码文件结构

各个类的接口及成员说明

账户

登录状态

图书

日志

块状链表

指令扫描解析

异常处理

文件存储说明

账户信息相关文件

图书信息文件

日志文件

其他补充说明