【免费下载】 sm-crypto 开源项目教程

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

sm-crypto 项目的目录结构如下：

sm-crypto/
├── dist/
│   ├── sm-crypto.js
│   └── sm-crypto.min.js
├── src/
│   ├── sm2/
│   │   ├── index.js
│   │   └── sm2.js
│   ├── sm3/
│   │   └── index.js
│   ├── sm4/
│   │   └── index.js
│   └── index.js
├── test/
│   ├── sm2.test.js
│   ├── sm3.test.js
│   └── sm4.test.js
├── .gitignore
├── .npmignore
├── LICENSE
├── package.json
├── README.md
└── webpack.config.js

目录结构介绍

• dist/：包含编译后的文件，如 sm-crypto.js 和 sm-crypto.min.js。
• src/：源代码目录，包含 sm2、sm3 和 sm4 的实现。
  • sm2/：SM2 算法的实现。
  • sm3/：SM3 算法的实现。
  • sm4/：SM4 算法的实现。
• test/：测试文件目录，包含各个算法的测试文件。
• .gitignore：Git 忽略文件配置。
• .npmignore：NPM 忽略文件配置。
• LICENSE：项目许可证。
• package.json：项目依赖和脚本配置。
• README.md：项目说明文档。
• webpack.config.js：Webpack 配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 src/index.js，它导入了 sm2、sm3 和 sm4 模块，并提供了统一的入口。

// src/index.js
import sm2 from './sm2'
import sm3 from './sm3'
import sm4 from './sm4'

export {
  sm2,
  sm3,
  sm4
}

启动文件介绍

• src/index.js：作为项目的入口文件，导入了各个算法的实现，并提供了统一的导出接口。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json 和 webpack.config.js。

package.json

package.json 文件包含了项目的元数据和依赖信息，以及一些脚本命令。

{
  "name": "sm-crypto",
  "version": "0.3.2",
  "description": "微信小程序 sm crypto 库",
  "main": "dist/sm-crypto.js",
  "scripts": {
    "build": "webpack",
    "test": "jest"
  },
  "keywords": [
    "sm2",
    "sm3",
    "sm4",
    "crypto"
  ],
  "author": "wechat-miniprogram",
  "license": "MIT",
  "devDependencies": {
    "babel-core": "^6.26.3",
    "babel-loader": "^7.1.5",
    "babel-preset-env": "^1.7.0",
    "jest": "^24.9.0",
    "webpack": "^4.41.2",
    "webpack-cli": "^3.3.10"
  }
}

webpack.config.js

webpack.config.js 文件是 Webpack 的配置文件，用于打包项目。

const path = require('path')

module.exports = {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),
    filename: 'sm-crypto.js',
    library: 'smCrypto',
    libraryTarget: 'umd'
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader',
          options: