Snowy（SnowyAdmin）——国内首个国密前后端分离快速开发平台

编程星辰海

于 2024-11-23 21:18:33 发布

阅读量1.4k

点赞数 17

分类专栏： # 后端 # 前端文章标签： Snowy 前端后端全栈

本文链接：https://blog.csdn.net/speaking_me/article/details/143996551

版权

前端同时被 2 个专栏收录

52 篇文章

订阅专栏

后端

11 篇文章

订阅专栏

今天给大家介绍一款深具潜力的开源项目——Snowy。

Snowy（SnowyAdmin）是国内首个国密前后端分离快速开发平台，集成国密加解密插件，软件层面完全符合等保测评要求，同时实现国产化机型、中间件、数据库适配。

它凭借其完善的功能和出色的架构设计，为中小型企业和开发团队提供了一种简便、灵活且高效的开发解决方案。

那现在有这么一个机会，你想不想学或者了解一下呢？如果想，那就直接走起，让我们一起见证Snowy的强大。

Snowy（SnowyAdmin）确实是一个值得关注的开源项目，它专注于提供一个符合国家安全标准的快速开发平台。

简单说一说

核心功能与特点

国密支持：Snowy集成了国家密码局认证的加密算法，确保数据传输和存储的安全性，满足了对安全性有高要求的应用需求。
前后端分离架构：采用了现代化的前后端分离设计模式，前端使用Vue.js或React等现代前端框架，后端基于Spring Boot构建，这种架构不仅提高了系统的可维护性和扩展性，还便于团队协作开发。
符合等保测评：软件设计严格遵循中国信息安全等级保护制度的要求，帮助企业和组织在建设信息系统时能够轻松通过安全评估。
全面的国产化支持：Snowy实现了对国产操作系统、服务器硬件、中间件及数据库的支持，如银河麒麟操作系统、龙芯处理器、达梦数据库等，有助于推动信息技术应用创新生态的发展。
丰富的模块化组件：提供了多种开箱即用的功能模块，包括权限管理、日志审计、工作流引擎等，可以显著降低开发成本，加快项目上线速度。
灵活易用的界面定制能力：用户可以根据自身业务需求自由定制界面样式和布局，无需深入了解底层技术细节即可完成个性化设置。

目标用户群

中小企业：对于预算有限但又需要高效、安全解决方案的企业来说，Snowy是一个理想的选择。
开发团队：无论是初创公司还是大型企业的内部开发团队，都可以利用Snowy快速搭建起符合国家标准的信息系统。
政府机构与事业单位：这些单位往往对数据安全有着严格的要求，Snowy提供的国密支持和等保合规特性正好满足了他们的需求。

发展前景

随着中国政府对信息安全重视程度的不断提高以及国产软硬件生态系统的逐步完善，像Snowy这样既注重安全性又强调易用性的开源项目将拥有广阔的发展空间。

未来，Snowy有望吸引更多开发者加入社区，共同推进项目的迭代升级，进一步扩大其影响力。

Snowy：深具潜力的开源项目介绍

一、项目背景

在数字化转型的大潮中，信息安全成为企业信息化建设中不可或缺的一环。Snowy（SnowyAdmin）正是在这样的背景下诞生的一款深具潜力的开源项目。它不仅是中国首个集成国密加解密插件的前后端分离快速开发平台，而且在软件层面上完全符合等保测评要求。

这一特点使得Snowy成为了众多企业和开发团队构建安全可靠的信息系统时的首选。

二、核心技术与功能

1. 国密加解密插件

Snowy集成了国密算法，如SM2、SM3、SM4等，用于数据签名和完整性保护，确保了数据在传输过程中的安全性和隐私性。

这不仅提升了系统的安全性，也符合了国家对于信息安全的标准和要求。

2. 前后端分离架构

Snowy采用了前后端分离的设计模式，前端基于Vue 3.2和Ant Design Vue，后端则基于Spring Boot 2.5和Mybatis Plus 3.5，构建出稳定高效的后台服务。

这种架构设计不仅提高了系统的可维护性和扩展性，同时也使得前后端开发更加独立，提高了开发效率。

3. 符合等保测评要求

Snowy在软件设计上严格遵守中国信息安全等级保护制度的要求，帮助企业轻松通过安全评估，确保了系统的合法性和合规性。

4. 国产化支持

Snowy实现了对国产操作系统、服务器硬件、中间件及数据库的全面支持，例如金仓、达梦数据库，东方通、中创中间件，以及国产服务器和浏览器等。

这一特点使得Snowy在促进信息技术应用创新生态的发展方面发挥着重要作用。

5. 丰富的功能模块

Snowy内置了权限管理、日志审计、工作流引擎、多租户管理、即时通讯等丰富功能模块，这些模块可以显著降低开发成本，加快项目上线速度。

6. 界面定制能力

用户可以根据自身业务需求自由定制界面样式和布局，无需深入了解底层技术细节即可完成个性化设置。

三、目标用户群体

中小企业：对于预算有限但又需要高效、安全解决方案的企业来说，Snowy是一个理想的选择。
开发团队：无论是初创公司还是大型企业的内部开发团队，都可以利用Snowy快速搭建起符合国家标准的信息系统。
政府机构与事业单位：这些单位往往对数据安全有着严格的要求，Snowy提供的国密支持和等保合规特性正好满足了他们的需求。

四、发展前景

随着中国政府对信息安全重视程度的不断提高以及国产软硬件生态系统的逐步完善，像Snowy这样既注重安全性又强调易用性的开源项目将拥有广阔的发展空间。未来，Snowy有望吸引更多开发者加入社区，共同推进项目的迭代升级，进一步扩大其影响力。

总之，Snowy不仅为开发者提供了一个强大的开发工具，也为推动国内信息安全技术和产业发展做出了积极贡献。无论是从技术层面还是从社会价值来看，Snowy都展现出了巨大的发展潜力和市场前景。

如何使用如何使用Snowy（SnowyAdmin）

无代码版

Snowy（SnowyAdmin）作为一个国内领先的国密前后端分离快速开发平台，提供了详尽的文档和教程，帮助开发者快速上手。以下是使用Snowy进行项目开发的基本步骤和一些关键点，希望能帮助您更好地理解和使用Snowy。

一、准备工作

环境准备：
- 开发环境：确保您的计算机上安装了Java JDK、Node.js、MySQL等必要的开发工具和依赖环境。Snowy支持多种数据库，如MySQL、Oracle、PostgreSQL等。
- IDE选择：推荐使用IntelliJ IDEA或Eclipse等IDE进行后端开发，使用VS Code或WebStorm进行前端开发。
下载Snowy：
- 访问Snowy的官方仓库，可以从GitHub或Gitee下载最新的源码。建议直接克隆仓库到本地，以便于后续的开发和调试。
项目初始化：
- 解压下载的源码包，导入到IDE中。
- 配置项目所需的数据库连接、Redis等外部服务信息。这些配置通常位于项目的application.yml文件中。

二、项目结构与核心模块

项目结构：
- 后端：基于Spring Boot构建，主要负责业务逻辑处理和数据持久化。核心模块包括snowy-common（通用模块）、snowy-plugin-auth（鉴权模块）、snowy-plugin-gen（代码生成器模块）等。
- 前端：基于Vue.js和Ant Design Vue构建，主要负责用户界面展示和交互。前端项目通常位于frontend目录下。
核心模块介绍：
- snowy-common：通用模块，包含了项目中常用的工具类、常量定义、异常处理等。
- snowy-plugin-auth：基于Sa-Token实现的鉴权模块，用于用户认证和权限控制。
- snowy-plugin-gen：代码生成器模块，可以帮助开发者快速生成CRUD接口和页面代码。
- snowy-plugin-workflow：工作流模块，支持流程定义和实例管理。
- snowy-plugin-message：消息通知模块，支持邮件、短信等通知方式。

三、快速开发指南

数据库建表：
- 根据业务需求，创建相应的数据库表。Snowy提供了丰富的数据库字段类型和注释，方便开发者理解和使用。
- 代码生成：
  - 使用Snowy的代码生成器模块，输入表名和相关配置，自动生成控制器、服务层、Mapper层以及前端页面代码。生成的代码结构清晰，注释丰富，易于理解和修改。
接口开发：
- 在后端项目中，根据业务需求编写控制器方法，处理HTTP请求。Snowy提供了完善的注解和工具类，简化了接口开发过程。
- 使用Swagger生成API文档，方便前端开发人员调用接口。
前端开发：
- 在前端项目中，根据生成的页面代码进行样式调整和功能扩展。Snowy采用了Ant Design Vue，提供了丰富的UI组件，方便快速搭建界面。
- 使用Vue Router进行路由配置，实现页面之间的导航。
测试与调试：
- 使用Postman或其他API测试工具，测试后端接口的正确性和稳定性。
- 在前端项目中，使用Vue Devtools进行调试，确保页面交互效果符合预期。
部署与发布：
- 完成开发和测试后，将项目打包并部署到生产环境。Snowy支持多种部署方式，如Docker容器化部署、传统Tomcat部署等。
- 部署完成后，进行最终的测试和验证，确保系统运行正常。

四、社区与支持

官方文档：Snowy提供了详细的官方文档，涵盖了从环境搭建到项目发布的各个环节，是开发者学习和参考的重要资源。
社区交流：加入Snowy的官方QQ群或GitHub/Gitee上的讨论区，与其他开发者交流经验，解决开发过程中遇到的问题。
技术支持：如果在使用过程中遇到技术难题，可以通过官方渠道寻求技术支持，获取专业的帮助和指导。

总结

通过以上步骤，大家可以快速上手Snowy（SnowyAdmin），并利用其强大的功能和优秀的架构设计，高效地开发出符合国家标准的信息系统。

无论是中小企业还是大型企业，Snowy都能为您提供一个简便、灵活且高效的开发解决方案。

希望Snowy能成为您项目开发中的得力助手。

那有没有具体代码版呢，好，说来就来！

Snowy（SnowyAdmin）进行项目开发的具体步骤，并附带相应的代码示例

一、准备工作

1. 环境准备

确保您的计算机上安装了以下工具：

Java JDK
Node.js
MySQL

2. 下载Snowy

克隆Snowy的官方仓库到本地：

git clone https://github.com/snowy-platform/snowy.git

3. 项目初始化

解压下载的源码包，导入到IDE中。假设您使用的是IntelliJ IDEA和VS Code。

后端项目初始化

打开application.yml文件，配置数据库连接信息：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/snowy?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=Asia/Shanghai
    username: root
    password: your_password
    driver-class-name: com.mysql.cj.jdbc.Driver

前端项目初始化

安装前端项目的依赖：

cd snowy/frontend
npm install

二、项目结构与核心模块

1. 项目结构

后端项目结构

snowy/
├── backend/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   │   └── cn/
│   │   │   │       └── snowy/
│   │   │   │           ├── common/
│   │   │   │           ├── plugin/
│   │   │   │           │   ├── auth/
│   │   │   │           │   ├── gen/
│   │   │   │           │   ├── workflow/
│   │   │   │           │   └── message/
│   │   │   │           └── system/
│   │   │   └── resources/
│   │   │       ├── application.yml
│   │   │       └── mapper/
└── frontend/
    ├── public/
    ├── src/
    │   ├── assets/
    │   ├── components/
    │   ├── layouts/
    │   ├── pages/
    │   ├── router/
    │   ├── store/
    │   ├── utils/
    │   └── App.vue
    ├── .env
    ├── babel.config.js
    ├── package.json
    └── vite.config.js

2. 核心模块介绍

snowy-common模块

// src/main/java/cn/snowy/common/utils/StringUtils.java
package cn.snowy.common.utils;

public class StringUtils {
    public static boolean isEmpty(String str) {
        return str == null || str.isEmpty();
    }

    public static boolean isNotEmpty(String str) {
        return !isEmpty(str);
    }
}

snowy-plugin-auth模块

// src/main/java/cn/snowy/plugin/auth/SaTokenConfig.java
package cn.snowy.plugin.auth;

import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.stp.StpUtil;
import cn.dev33.satoken.config.SaTokenConfig;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SaTokenConfig {

    @Bean
    public SaTokenConfig getSaTokenConfig() {
        SaTokenConfig config = new SaTokenConfig();
        config.setTokenName("satoken");
        config.setIsConcurrent(true);
        config.setTimeout(24 * 60 * 60);
        config.setActivityTimeout(30 * 60);
        config.setIsShare(true);
        config.setPrefix("sa-token-");
        config.setCheckRepLogin(true);
        config.setTokenStyle("uuid");
        return config;
    }

    @Bean
    public void initSaToken() {
        SaManager.setConfig(getSaTokenConfig());
        StpUtil.setLoginId("123456");
    }
}

三、快速开发指南

1. 数据库建表

假设我们需要创建一个用户表：

-- src/main/resources/db/migration/V1__init.sql
CREATE TABLE `user` (
  `id` bigint NOT NULL AUTO_INCREMENT,
  `username` varchar(50) NOT NULL,
  `password` varchar(100) NOT NULL,
  `email` varchar(100) DEFAULT NULL,
  `create_time` datetime DEFAULT CURRENT_TIMESTAMP,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;

2. 代码生成

使用Snowy的代码生成器模块生成用户管理的代码：

# 运行代码生成器
cd snowy/backend
mvn clean compile exec:java -Dexec.mainClass="cn.snowy.plugin.gen.GenApplication"

3. 接口开发

在后端项目中，创建用户控制器：

// src/main/java/cn/snowy/system/controller/UserController.java
package cn.snowy.system.controller;

import cn.snowy.common.core.BaseController;
import cn.snowy.common.core.R;
import cn.snowy.system.entity.User;
import cn.snowy.system.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
@RequestMapping("/user")
@Api(tags = "用户管理")
public class UserController extends BaseController {

    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    @ApiOperation("根据ID获取用户信息")
    public R<User> getUserById(@PathVariable Long id) {
        User user = userService.getUserById(id);
        return success(user);
    }

    @PostMapping
    @ApiOperation("添加用户")
    public R<Void> addUser(@RequestBody User user) {
        userService.addUser(user);
        return success();
    }

    @PutMapping
    @ApiOperation("更新用户")
    public R<Void> updateUser(@RequestBody User user) {
        userService.updateUser(user);
        return success();
    }

    @DeleteMapping("/{id}")
    @ApiOperation("删除用户")
    public R<Void> deleteUser(@PathVariable Long id) {
        userService.deleteUser(id);
        return success();
    }
}

4. 前端开发

在前端项目中，创建用户管理页面：

<!-- src/pages/user/UserList.vue -->
<template>
  <a-card title="用户管理">
    <a-table :columns="columns" :data-source="users" />
  </a-card>
</template>

<script>
export default {
  data() {
    return {
      columns: [
        { title: '用户名', dataIndex: 'username' },
        { title: '邮箱', dataIndex: 'email' },
        { title: '创建时间', dataIndex: 'createTime' },
      ],
      users: [],
    };
  },
  async created() {
    await this.fetchUsers();
  },
  methods: {
    async fetchUsers() {
      const response = await this.$axios.get('/user');
      this.users = response.data;
    },
  },
};
</script>

5. 测试与调试

使用Postman测试后端接口：

GET http://localhost:8080/user/1
POST http://localhost:8080/user
{
  "username": "test",
  "password": "password",
  "email": "test@example.com"
}

在前端项目中，启动开发服务器：

cd snowy/frontend
npm run serve

6. 部署与发布

打包前端项目：

cd snowy/frontend
npm run build

打包后端项目：

cd snowy/backend
mvn clean package -Dmaven.test.skip=true

将打包后的文件部署到生产环境服务器。

四、社区与支持

官方文档：访问Snowy的官方文档，获取更多详细信息。
社区交流：加入Snowy的官方QQ群或GitHub/Gitee上的讨论区，与其他开发者交流经验。
技术支持：如果在使用过程中遇到技术难题，可以通过官方渠道寻求技术支持。

它难点在哪里

使用Snowy（SnowyAdmin）进行项目开发虽然有许多优点，但也存在一些潜在的难点，这些难点可能会对开发效率和项目质量产生影响。

以下是一些常见的难点及其应对策略：

1. 技术栈的复杂性

1.1 技术栈更新频繁

Snowy采用了多种前沿技术栈，如Spring Boot、MyBatis Plus、Vue 3、Ant Design Vue等。这些技术栈的更新频率较高，可能会导致项目依赖冲突或兼容性问题。

应对策略：

定期更新依赖：定期检查项目依赖，确保所有依赖库都是最新版本。
版本锁定：在项目初期明确所有依赖库的版本，并在pom.xml或package.json中固定版本号，避免意外升级带来的问题。

2. 国密算法的复杂性

2.1 国密算法的配置和使用

Snowy集成了国密算法（如SM4），确保数据的安全性和合规性。然而，这些算法的配置和使用相对复杂，需要一定的密码学知识。

应对策略：

学习国密算法：提前学习国密算法的基本概念和使用方法，确保正确配置和使用。
参考官方文档：仔细阅读Snowy官方文档中关于国密算法的部分，确保理解每个配置项的意义。

3. 权限管理的复杂性

3.1 权限管理的灵活性

Snowy使用Sa-Token进行权限管理，提供了丰富的权限控制功能。然而，这种灵活性也可能带来复杂性，尤其是在大规模系统中，权限配置可能变得非常复杂。

应对策略：

权限设计：在项目初期设计好权限模型，明确每个角色的权限范围。
权限复审：定期复审权限配置，确保权限分配的合理性。

4. 前后端分离的挑战

4.1 前后端协调

前后端分离的架构要求前后端开发人员之间有良好的沟通和协调。任何一方的改动都可能影响另一方的工作。

应对策略：

接口文档：编写详细的接口文档，确保前后端开发人员对每个接口的理解一致。
联合调试：定期进行联合调试，及时发现和解决问题。

5. 性能优化的挑战

5.1 数据库性能优化

随着系统数据量的增加，数据库性能优化变得尤为重要。复杂的查询和大量的数据操作可能会导致性能瓶颈。

应对策略：

索引优化：合理使用索引，避免全表扫描。
查询优化：优化SQL查询语句，减少不必要的数据加载。

6. 缓存机制的管理

6.1 缓存一致性

使用Redis等缓存机制可以显著提升系统性能，但缓存一致性问题需要特别注意。

应对策略：

缓存失效策略：设计合理的缓存失效策略，确保数据的一致性。
分布式锁：使用分布式锁机制，避免多节点同时操作缓存数据。

7. 代码生成的局限性

7.1 代码生成的局限性

虽然Snowy提供了强大的代码生成器，但生成的代码可能无法完全满足复杂的业务需求，需要手动修改和扩展。

应对策略：

代码审查：生成代码后进行详细的代码审查，确保代码质量和业务逻辑的正确性。
模板定制：根据业务需求定制代码生成模板，提高生成代码的质量。

8. 测试与调试的挑战

8.1 测试覆盖率

确保项目有足够的测试覆盖率，特别是对于核心业务逻辑和复杂模块。

应对策略：

单元测试：编写单元测试用例，确保每个模块的功能正确性。
集成测试：进行集成测试，确保各个模块之间的交互正常。

9. 部署与运维的挑战

9.1 环境一致性

确保开发环境、测试环境和生产环境的一致性，避免因环境差异导致的问题。

应对策略：

环境标准化：使用Docker等容器技术进行环境标准化部署。
持续集成：建立持续集成和持续部署（CI/CD）流程，自动化测试和部署过程。

10. 社区支持的局限性

10.1 社区活跃度

尽管Snowy有一个活跃的社区，但在某些特定问题上可能缺乏足够的支持。

应对策略：

主动提问：在社区中积极提问和分享经验，增加社区活跃度。
官方支持：联系Snowy官方团队，获取专业的技术支持。