cc-project详细文档

 

原创河码开源

介绍

cc-project 是一个前后端分离的权限项目，主要有用户管理、部门管理、角色管理、菜单管理、按钮管理、访问地址管理、数据权限管理、数据字典管理、系统公告管理、系统信息、登录日志管理、系统日志管理、界面布局示例等功能，可根据角色控制菜单、按钮（头部按钮、行按钮、下拉按钮等）、访问地址、行级数据访问、数据字典数据权限等；后端采用spring boot、mybatis 以及多数据源管理、后端采用maven分模块开发，数据库采用mysql8.0，其它内容请参考后续章节。

版本

目前后端只有一套，前端分为angular11、vue3.0版本，计划开发react版本

技术

前端技术

angular版本

angular11+ng-zorro-antd11+less

vue版本

vue3.0+ant-design-vue2+less

 

后端技术

spring boot+mybatis3.1.1 + maven+mysql8.0

 

目录结构

前端

angular版本

angular版本将功能的代码分为平台和业务两个部分，平台代码是所有平台功能以及公共部分的实现，业务部分是提供给二次开发者自己的功能实现，这样把平台和业务就分开了，不是平台问题，建议不要修改平台代码和资源文件，这样有利于平台的干净，后续代码更新不会出现冲突。

e2e	端到端的测试目录
src	源代码目录
src/app	应用代码目录
src/app/business	业务功能目录，所有业务功能的实现在里面，这样做可以把平台和业务的实现分开
src/app/home	整个应用的主页
src/app/layout	整个应用布局
src/app/login	整个应用的登录
src/app/platform	平台功能目录，所有平台功能都在里面，这样做可以把平台和业务的实现分开
src/app/app.component	整个应用的根组件
src/app/app.guard	整个应用的守卫，继承了平台的守卫实现
src/app/app.module	整个应用的根模块
src/app/app-http-interceptor	整个应用的拦截器，继承了平台的拦截器实现
src/app/app-routing.module	整个应用的根路由配置
src/app/platform/api	平台功能的api目录，就是跟后端请求的方法
src/app/platform/common	平台功能的公共目录，包含常量、工具类、枚举、实体类
src/app/platform/shared	平台功能的共享目录，里面包含平台公共的指令、组件、管道、验证器等
src/app/platform/view	平台功能的视图目录，所有的平台部分的功能页面，例如：用户管理、角色管理等等等
src/app/business/api	业务功能的api目录，就是跟后端请求的方法
src/app/business/view	业务功能的视图目录，所有业务功能页面可以放在这里面，目前放一些示例页面
src/assets	资源目录
src/assets/app/less	应用的主题less目录，里面可以配置平台的主题
src/assets/platform	平台资源目录，里面有扩展的图标、平台图片、平台的扩展less、重写less、主题less
src/assets/platform/platform-overwrite/less	平台less的覆盖，我们建议不要直接去修改平台的less,而是通过这个目录的less来重写，这样平台会保持很干净，后续平台有更新，不会有冲突，上面代码部分之所以也分平台的业务，同样是希望使用者不要去直接修改平台，业务写在业务目录，这样好维护
src/environments	整个应用的环境变量，里面的配置有注释
其它	其它的目录和文件都是angular标准文件和目录这里面不讲了

vue版本

vue版本所有代码都写在一起，没有平台的业务的分离。

app-config	应用插件配置目录
app-config/build	vite配置
app-config/plugin	vite的插件
src	源代码
src/api	api目录，就是跟后端请求的方法
src/assets	资源文件目录
src/assets/icon	图标，因为ant-design-vue的所有图标都是组件实现，对于一些图标需要放在后端保存，这里面不太适用，所以直接引入iconfont，其中antd的目录下放的是antd的所有图标，app目录下放的是应用自己扩展的图标，icon.less是将所有图标整合在一起，直接在main.ts中引入
src/assets/img	应用中使用到的图片
src/assets/less	应用中使用的less，里面有公共的、覆盖的、主题等
src/common	公共的工具类、常量目录
src/components	公共的组件目录
src/config	配置目录，里面有antd的全局配置
src/directives	公共的指令目录
src/layouts	公共的布局目录，里面提供了两个布局和布局使用的组件
src/pipes	公共的管道，这个思想来源于angular，vue叫过滤器，用于做一些数据转换
src/router	所有的路由配置，app-module里面配置每个模块的路由，每个模块自己创建一个模块路由文件，这样多人开发不容易git提交冲突
src/store	所有的store配置，app-module里面配置每个状态的的store，这样多人开发不容易git提交冲突
src/types	应用的类型，同后端的model对应上
src/use	这里面配置是的全局的use，例如antd的，自定义的组件、指令，比较少用的组件和指令建议还是局部引入
src/validator	所有的表单公共验证器，例如：电话、邮箱等，这个同angular的一样
src/views	所有功能的页面实现
App.vue	应用根
main.ts	应用入口
.env、.env.development、.env.production	环境变量配置文件
vite.config.ts	vite配置文件
其它	其它的目录和文件都是标准文件和目录这里面不讲了

后端

后端是多数据源的项目，通过maven，将平台和业务通过子工程分开，各个有各个的数据源。

cc-console	主入口，是一个maven子工程，里面包含了全局的一些配置和入口Application
cc-demo-common	示例公共部分，是一个maven子工程，里面只有一个modal
cc-demo-impl	示例dao、service实现部分，是一个maven子工程，里面的base里是一个多数据源的实现，项目的做法是，平台数据库和业务数据库分开，所有单独添加了一个数据源
cc-demo-web	示例的controller请求
cc-sys-common	平台的公共实现，里面有注释、常量、工具类、接口、实体类
cc-sys-impl	平台的dao、service实现部分，是一个maven子工程，里面的base里是一个多数据源的实现，项目的做法是，平台数据库和业务数据库分开，所有单独添加了一个数据源
cc-sys-web	平台功能的controller请求
readme	里面有数据库脚本、简单的文档
pom	主工程的pom文件
其它	具体的请看目录

使用

数据库导入

平台的数据库：在mysql8.0中先创建一个sys_db数据库，在cc-app-backed\readme\data\全库数据目录下找到sys_db.sql脚本导入。

示例数据库：创建一个demo_db数据库，引入 demo_db.sql

前端配置

angular版本

主要是环境变量的配置，可以查看变量文件，里面有注释

vue版本

1.vite的配置在app-config目录下和vite.config.ts中

2.antd全局配置在
config/antd-global-config.ts中

3.路由的配置在router目录中

4.store的配置在store目录中

5.全局的引入配置在use中

 

后端配置

主要在cc-app-console中，里面有ehcache配置，application配置，日志配置，应用配置

 

添加数据源配置：

1.首页创建一个maven中工程，参考demo，

2.然后创建一个base包，然后创建一个config和一个dao包，

3.config中创建datasource类，主要是配置Atomikos，配置内容放在
application-xxx.properties文件中，

#--------demo dataSource config--------
demo.uniqueResourceName=demoDataSource
demo.xaDataSourceClassName=com.mysql.cj.jdbc.MysqlXADataSource
demo.xaUrl=jdbc:mysql://127.0.0.1:3306/demo_db?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=UTC
demo.xaUser=root
demo.xaPassword=root
demo.minPoolSize=10
demo.maxPoolSize=200
demo.borrowConnectionTimeout=30
demo.testQuery=select 1
demo.maintenanceInterval=60


#demo mybatis
demo.dialect=mysql
demo.stmtIdRegex=*Paging

#demo mybatis cfg
demo.mybatis.configLocation=mybatis/demo/mybatis-config.xml
demo.mybatis.mapperLocations=/mybatis/demo/mapper/*/*.xml

package com.cjhme.demo.impl.base.config;

import java.util.Properties;

import javax.annotation.Resource;
import javax.sql.DataSource;

import org.apache.ibatis.plugin.Interceptor;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.SqlSessionTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;

import com.cjhme.system.impl.base.mybatis.interceptor.PrepareInterceptor;


/**
 *
 * 

 * Title: MyBatisConfig.java
 * 
 * Description: mybatis配置
 * 

 * Modify histoty:
 *
 * @author cjh
 * @version 1.0
 */
@Configuration
public class DemoSessionTemplateConfig {

    @Autowired
    private Environment env;

    @Resource(name="demo.dataSource")
    private DataSource demoDataSource;



    /**
     * sqlSessionTemplate
     * @return
     * @throws Exception
     */
    @Bean(name="demo.sqlSessionTemplate")
    public SqlSessionTemplate demoSessionTemplate() throws Exception {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setConfigLocation(new ClassPathResource(env.getProperty("demo.mybatis.configLocation")));
        PathMatchingResourcePatternResolver pathMatchingResourcePatternResolver = new PathMatchingResourcePatternResolver();
        String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + env.getProperty("demo.mybatis.mapperLocations");
        sqlSessionFactoryBean.setMapperLocations(pathMatchingResourcePatternResolver.getResources(packageSearchPath));

        sqlSessionFactoryBean.setDataSource(demoDataSource);

        PrepareInterceptor prepareInterceptor = new PrepareInterceptor(this.env);
        Properties properties=new Properties();
        properties.setProperty("dialect",env.getProperty("demo.dialect"));
        properties.setProperty("stmtIdRegex",env.getProperty("demo.stmtIdRegex"));
        prepareInterceptor.setProperties(properties);
        
        sqlSessionFactoryBean.setPlugins(new Interceptor[]{prepareInterceptor});

        return  new SqlSessionTemplate(sqlSessionFactoryBean.getObject());
    }


}

4.config中创建sessionTemplate，将上面创建的datasource注入就可以了使用就可以了

package com.cjhme.demo.impl.base.config;

import java.util.Properties;

import javax.annotation.Resource;
import javax.sql.DataSource;

import org.apache.ibatis.plugin.Interceptor;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.SqlSessionTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;

import com.cjhme.system.impl.base.mybatis.interceptor.PrepareInterceptor;


/**
 *
 * 

 * Title: MyBatisConfig.java
 * 
 * Description: mybatis配置
 * 

 * Modify histoty:
 *
 * @author cjh
 * @version 1.0
 */
@Configuration
public class DemoSessionTemplateConfig {

    @Autowired
    private Environment env;

    @Resource(name="demo.dataSource")
    private DataSource demoDataSource;



    /**
     * sqlSessionTemplate
     * @return
     * @throws Exception
     */
    @Bean(name="demo.sqlSessionTemplate")
    public SqlSessionTemplate demoSessionTemplate() throws Exception {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setConfigLocation(new ClassPathResource(env.getProperty("demo.mybatis.configLocation")));
        PathMatchingResourcePatternResolver pathMatchingResourcePatternResolver = new PathMatchingResourcePatternResolver();
        String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX + env.getProperty("demo.mybatis.mapperLocations");
        sqlSessionFactoryBean.setMapperLocations(pathMatchingResourcePatternResolver.getResources(packageSearchPath));

        sqlSessionFactoryBean.setDataSource(demoDataSource);

        PrepareInterceptor prepareInterceptor = new PrepareInterceptor(this.env);
        Properties properties=new Properties();
        properties.setProperty("dialect",env.getProperty("demo.dialect"));
        properties.setProperty("stmtIdRegex",env.getProperty("demo.stmtIdRegex"));
        prepareInterceptor.setProperties(properties);
        
        sqlSessionFactoryBean.setPlugins(new Interceptor[]{prepareInterceptor});

        return  new SqlSessionTemplate(sqlSessionFactoryBean.getObject());
    }


}

dao中创建BaseDao继承DaoPageExtend（分页实现），注入sqlSessionTemplate

package com.cjhme.demo.impl.base.dao;

import javax.annotation.Resource;

import org.mybatis.spring.SqlSessionTemplate;

import com.cjhme.system.impl.base.mybatis.dao.DaoPageExtend;

/**
 * 
 * 

 * Title: BaseDao.java
 * 
 * Description: 基础BaseDao，所有dao继承BaseDao
 * 

 * Modify histoty:
 * 
 * @author cjh
 * @version 1.0
 */
public abstract class BaseDao extends DaoPageExtend {

	@Resource(name = "demo.sqlSessionTemplate")
	public void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate) {
		this.sqlSessionTemplate = sqlSessionTemplate;
	}

	public SqlSessionTemplate getSqlSessionTemplate() {
		return sqlSessionTemplate;
	}

}

dao impl使用时需要继承baseDao就可以使用sqlSessionTemplate和分页实现了

package com.cjhme.demo.impl.dao.student.impl;

import java.util.Map;

import org.springframework.stereotype.Repository;

import com.cjhme.common.model.base.DataPaging;
import com.cjhme.demo.common.model.DemoBean;
import com.cjhme.demo.impl.base.dao.BaseDao;
import com.cjhme.demo.impl.dao.student.StudentDao;

@Repository("demo.studentDao")
public class StudentDaoImpl extends BaseDao implements StudentDao {

	public DataPaging