若依文档详解

若依是一套基于Spring Cloud和Vue前后端分离的权限管理系统，其文档详细介绍了若依的功能与使用方法，本文将从多个方面对若依文档进行详解。

一、快速开始

若依文档提供了详细的快速开始指南，可以帮助开发者快速了解若依的使用方法。

在快速开始指南中，首先介绍了若依需要的环境和依赖，包括Java 8、Maven 3.3+、MySQL 5.7+等，具体介绍了如何在本地搭建开发环境。

接着，文档介绍了如何下载若依源代码，并进行编译和运行。文档给出了详细的步骤和截图，方便开发者进行实践。

cd whvn-auth-system
mvn clean package -DskipTests
java -jar whvn-auth-system/whvn-auth-system.jar

除了以上内容，快速开始指南还介绍了如何使用Postman进行接口测试以及如何在IDE中进行调试等。

二、系统管理

系统管理是若依的核心功能之一，主要包括用户管理、角色管理、菜单管理、部门管理等，若依文档对这些功能都进行了详细的介绍。

例如，在用户管理方面，文档详细介绍了如何进行用户的增删改查、如何为用户分配角色等，同时还介绍了如何通过Excel批量导入用户。

/**
* 保存用户信息
*/
@PreAuthorize("@ss.hasPermi('system:user:add')")
@PostMapping
public AjaxResult add(@Validated @RequestBody SysUser user)
{
    if (UserConstants.NOT_UNIQUE.equals(userService.checkUserNameUnique(user.getUserName())))
    {
        return AjaxResult.error("新增用户'" + user.getUserName() + "'失败，登录账号已存在");
    }
    else if (UserConstants.NOT_UNIQUE.equals(userService.checkPhoneUnique(user)))
    {
        return AjaxResult.error("新增用户'" + user.getUserName() + "'失败，手机号码已存在");
    }
    else if (UserConstants.NOT_UNIQUE.equals(userService.checkEmailUnique(user)))
    {
        return AjaxResult.error("新增用户'" + user.getUserName() + "'失败，邮箱账号已存在");
    }
    user.setSalt(ShiroUtils.randomSalt());
    user.setPassword(passwordService.encryptPassword(user.getUserName(), user.getPassword(), user.getSalt()));
    return toAjax(userService.insertUser(user));
}

类似的，菜单管理、角色管理、部门管理等功能也都有详细的介绍和代码示例。

三、安全管理

若依文档也重点介绍了安全管理方面的内容，包括用户认证、API接口安全等。

对于用户认证，若依采用了Shiro框架，文档介绍了如何进行自定义Realm以及如何实现多种认证方式等。

public class UserRealm extends AuthorizingRealm
{
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals)
    {
        SimpleAuthorizationInfo authorizationInfo = new SimpleAuthorizationInfo();
        SysUser user = ShiroUtils.getSysUser();
        // 获取角色集合
        Set<String> roles = roleService.selectRoleKeys(user.getUserId());
        authorizationInfo.setRoles(roles);
        // 获取权限集合
        Set<String> perms = menuService.selectPermsByUserId(user.getUserId());
        authorizationInfo.setStringPermissions(perms);
        return authorizationInfo;
    }

    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException
    {
        String username = (String)token.getPrincipal();
        String password = new String((char[])token.getCredentials());
        SysUser user = userService.selectUserByUserName(username);
        if (user == null)
        {
            throw new UnknownAccountException("用户不存在");
        }
        if (!passwordService.matches(user, password))
        {
            throw new IncorrectCredentialsException("密码不正确");
        }
        if (UserStatus.DELETED.getCode().equals(user.getDelFlag()))
        {
            throw new LockedAccountException("用户已被删除");
        }
        return new SimpleAuthenticationInfo(user, password, getName());
    }
}

在API接口安全方面，若依文档详细介绍了如何使用Spring Security进行API接口的安全控制，包括如何设置跨域、如何进行用户认证、如何进行接口权限控制等。

四、前端开发

若依采用了Vue.js作为前端框架，文档也有详细的介绍和代码示例。主要包括如何使用Vue Router、如何使用Element UI等。

export default [
  {
    path: '/login',
    component: () => import('@/views/login/index'),
    hidden: true,
    meta: { title: '登录' }
  },
  {
    path: '/',
    component: Layout,
    redirect: '/dashboard',
    children: [
      {
        path: 'dashboard',
        component: () => import('@/views/dashboard/index'),
        name: 'Dashboard',
        meta: { title: '首页', icon: 'dashboard', affix: true }
      }
    ]
  },
  {
    path: '/system',
    component: Layout,
    redirect: '/system/user',
    name: 'System',
    meta: { title: '系统管理', icon: 'system' },
    children: [
      {
        path: 'user',
        component: () => import('@/views/system/user/index'),
        name: 'User',
        meta: { title: '用户管理', icon: 'user' }
      },
      {
        path: 'role',
        component: () => import('@/views/system/role/index'),
        name: 'Role',
        meta: { title: '角色管理', icon: 'peoples' }
      },
      {
        path: 'menu',
        component: () => import('@/views/system/menu/index'),
        name: 'Menu',
        meta: { title: '菜单管理', icon: 'tree-table' }
      }
    ]
  }
]

类似的，文档还介绍了如何进行前后端联调、如何进行权限控制等内容。