SpringBoot 封装组件方式二

痛定思痛。 2023-10-10 10:28 23阅读 0赞

第二种：基于通用配置参数包+Spring 注解标签，实现相关组件封装

任务要求：完成数据库指定表转换为SQL语句(增、删、改和查)

为什么采用通用配置参数模块，之前采用SpringBoot 封装组件方式一，打包jar 时，maven 提示相关资源无法找到，所以将各个封装组件依赖的配置参数统一配置到一个专门存储配置参数的jar 包中，截图如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70][]

核心功能代码：

import java.io.BufferedReader;
    import java.io.IOException;
    import java.io.InputStream;
    import java.io.InputStreamReader;
    import java.util.Properties;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.jdbc.core.JdbcTemplate;
    import org.springframework.jdbc.datasource.DriverManagerDataSource;
    import com.***.ucas.mapping.config.domain.MappingConfigEntity;
    import com.***.ucas.mapping.util.MappingUtil;
    
    @Configuration
    public class MappingConfig {
    	
    	public static MappingConfigEntity config = new MappingConfigEntity();
    	static {
    		Properties properties = new Properties(); 
    		InputStream stream = MappingConfig.class.getClassLoader().getResourceAsStream("mapper.properties");
    		BufferedReader reader= new BufferedReader(new InputStreamReader(stream));
    		
    		try {
    			properties.load(reader);
    			config.setDriverClassName(properties.getProperty("jdbc.driverClassName"));
    			config.setUrl(properties.getProperty("jdbc.url"));
    			config.setUsername(properties.getProperty("jdbc.username"));
    			config.setPassword(properties.getProperty("jdbc.password"));
    			
    		} catch (IOException e) {
    			// 自定义错误信息提示输出，并终止程序执行。
    		}
    	}
    	
    	/**
    	 * DataSource 实例化对象
    	 * @return
    	 */
    	@Bean
    	public DriverManagerDataSource getDataSource(){
    		DriverManagerDataSource dataSource = new DriverManagerDataSource();
    		dataSource.setDriverClassName(config.getDriverClassName());
    		dataSource.setUrl(config.getUrl());
    		dataSource.setUsername(config.getUsername());
    		dataSource.setPassword(config.getPassword());
    		return dataSource;
    	}
    	
    	/**
    	 * JdbcTemplate 实例化对象
    	 * @return
    	 */
    	@Bean
    	public JdbcTemplate getJdbcTemplate(){
    		JdbcTemplate template = new JdbcTemplate(getDataSource());
    		return template;
    		
    	}
    	
    	@Bean
    	public MappingUtil getMappingUtil(){
    		MappingUtil util = new MappingUtil();
    		util.setTemplate(getJdbcTemplate());
    		return util;
    	}
    
    }

public class MappingConfigEntity {
    	    // 数据库url
    		private String url;
    		// 数据库用户名
    		private String username;
    		// 数据库密码
    		private String password;
    		// 数据库驱动
    		private String driverClassName;
    		
    		// set 和  get
    		public String getUrl() {
    			return url;
    		}
    		public void setUrl(String url) {
    			this.url = url;
    		}
    		public String getUsername() {
    			return username;
    		}
    		public void setUsername(String username) {
    			this.username = username;
    		}
    		public String getPassword() {
    			return password;
    		}
    		public void setPassword(String password) {
    			this.password = password;
    		}
    		public String getDriverClassName() {
    			return driverClassName;
    		}
    		public void setDriverClassName(String driverClassName) {
    			this.driverClassName = driverClassName;
    		}
    
    }

import java.lang.reflect.Field;
    import java.lang.reflect.Modifier;
    import java.util.List;
    import java.util.Vector;
    
    import com.***.common.util.ClassConvertTable;
    import com.***.common.util.ReflectionUtils;
    import com.***.ucas.mapping.annotation.ID;
    
    /**
     * 基于java 实体对象创建sql的增删改查功能。
     * 
     * @author zzg
     *
     */
    public class EntityUtil {
    	
    	
    	// class目标
    	private Class<?> target;
    	// 实例化对象
    	private Object obj;
    	// sql 数据类型
    	private SqlType currentType;
    	// sql 构建器
    	private String sqlBuffer;
    	// sql 请求参数
    	private List<Object> param = new Vector<Object>();
    	
    	// 创建枚举对象
    	public enum SqlType {
    		INSERT, UPDATE, DELETE
    	}
    
    	// 工具实列化(构造函数)
    	public EntityUtil(SqlType sqlType, Class<?> target, Object obj) {
    		this.obj = 
    		this.target = target;
    		switch (sqlType) {
    		case INSERT:
    			currentType = SqlType.INSERT;
    			createInsert();
    			break;
    		case UPDATE:
    			currentType = SqlType.UPDATE;
    			createUpdate();
    			break;
    		case DELETE:
    			currentType = SqlType.DELETE;
    			createDelete();
    			break;
    		}
    	}
    	
    	// set 和  get 方法
    	public Class<?> getTarget() {
    		return target;
    	}
    
    	public void setTarget(Class<?> target) {
    		this.target = target;
    	}
    
    //	public String getIdName() {
    //		return idName;
    //	}
    //
    //	public void setIdName(String idName) {
    //		this.idName = idName;
    //	}
    //
    //	public Object getIdValue() {
    //		return idValue;
    //	}
    //
    //	public void setIdValue(Object idValue) {
    //		this.idValue = idValue;
    //	}
    
    	public SqlType getCurrentType() {
    		return currentType;
    	}
    
    	public void setCurrentType(SqlType currentType) {
    		this.currentType = currentType;
    	}
    
    	public String getSqlBuffer() {
    		return sqlBuffer;
    	}
    
    	public void setSqlBuffer(String sqlBuffer) {
    		this.sqlBuffer = sqlBuffer;
    	}
    
    	public List<Object> getParam() {
    		return param;
    	}
    
    	public void setParam(List<Object> param) {
    		this.param = param;
    	}
    
    	public Object getObj() {
    		return obj;
    	}
    
    	public void setObj(Object obj) {
    		this.obj = obj;
    	}
    
    	public void createDelete() {
    		// 数据库表名称
    		String tableName = ClassConvertTable.getTableName(target.getClass());
    		// 实体对象涉及属性值
    		Field[] fields = ReflectionUtils.getAllFields(target.getClass());
    		StringBuffer sqlBuffer = new StringBuffer();
    		sqlBuffer.append("DELETE FROM ").append(tableName).append(" WHERE ");
    		for (Field field : fields) {
    			if (!Modifier.isStatic(field.getModifiers())) {
    				ID id = field.getAnnotation(ID.class);
    				if (null != id) {
    					sqlBuffer.append(field.getName()).append("=?");
    				}
    			}
    		}
    		// 赋值sql delete 语句
    		this.sqlBuffer = sqlBuffer.toString();
    	}
    
    	
    
    	public void createUpdate() {
    		// 数据库表名称
    		String tableName = ClassConvertTable.getTableName(target.getClass());
    		// 实体对象涉及属性值
    		Field[] fields = ReflectionUtils.getAllFields(target.getClass());
    		StringBuffer sqlBuffer = new StringBuffer();
    		sqlBuffer.append("UPDATE ").append(tableName).append(" SET ");
    		for (Field field : fields) {
    			if (!Modifier.isStatic(field.getModifiers())) {
    				ID id = field.getAnnotation(ID.class);
    				if (id == null) {
    					sqlBuffer.append(field.getName()).append("=?");
    					param.add(ReflectionUtils.getFieldValue(target, field.getName()));
    				} else {
    //					idName = field.getName();
    //					idValue = ReflectionUtils.getFieldValue(target, field.getName());
    				}
    			}
    		}
    		// 处理条件
    //		if (idName == null) {
    //			throw new RuntimeException("not found of " + target.getClass() + "'s ID");
    //		}
    //		sqlBuffer.append(" WHERE ").append(idName).append("=?");
    //		param.add(idValue);
    		// 赋值sql update 语句
    		this.sqlBuffer = sqlBuffer.toString();
    	}
    
    	public void createInsert() {
    		// 数据库表名称
    		String tableName = ClassConvertTable.getTableName(target);
    		// 实体对象涉及属性值
    		Field[] fields = ReflectionUtils.getAllFields(target);
    		StringBuffer sqlBuffer = new StringBuffer();
    		sqlBuffer.append("INSERT INTO ").append(tableName).append("(");
    
    		for (Field field : fields) {
    			sqlBuffer.append(field.getName()).append(",");
    			// 填充请求参数
    			param.add(ReflectionUtils.getFieldValue(obj, field.getName()));
    	
    		}
    		int length = sqlBuffer.length();
    		sqlBuffer.delete(length - 1, length).append(")values(");
    		int size = param.size();
    		for (int x = 0; x < size; x++) {
    			if (x != 0) {
    				sqlBuffer.append(",");
    			}
    			sqlBuffer.append("?");
    		}
    		sqlBuffer.append(")");
    		// 赋值sql insert 语句
    		this.sqlBuffer = sqlBuffer.toString();
    	}
    
    }

mapper组件依赖的pom.xml 文件

<dependencies>
    		
    		<dependency>
    			<groupId>com.***</groupId>
    			<artifactId>***commmon-base</artifactId>
    			<version>0.0.1-SNAPSHOT</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>com.***</groupId>
    			<artifactId>***-common-setting</artifactId>
    			<version>0.0.1-SNAPSHOT</version>
    		</dependency>
    	</dependencies>

base 模块的pom.xml 文件

<properties>
    		<spring.version>4.3.21.RELEASE</spring.version>
    		<commons-lang.version>2.6</commons-lang.version>
    		<commons-codec.version>1.10</commons-codec.version>
    		<commons-lang3.version>3.8.1</commons-lang3.version>
    		<commons-net.version>3.6</commons-net.version>
    		<commons-io.version>2.6</commons-io.version>
    		<commons-collections.version>3.2.1</commons-collections.version>
    		<servlet-api.version>3.1.0</servlet-api.version>
    		<fastjson.version>1.2.48</fastjson.version>
    		<oshi-core.version>3.9.1</oshi-core.version>
    		<mysql-connector-java.version>8.0.11</mysql-connector-java.version>
    		<spring-data-redis.version>2.1.2.RELEASE</spring-data-redis.version>
    		<jedis.version>3.0.1</jedis.version>
    	</properties>
    
    	
    	<dependencies>
    		
    		
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-core</artifactId>
    			<version>${spring.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-context</artifactId>
    			<version>${spring.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-context-support</artifactId>
    			<version>${spring.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-beans</artifactId>
    			<version>${spring.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-expression</artifactId>
    			<version>${spring.version}</version>
    		</dependency>
    
    		
    		
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-aop</artifactId>
    			<version>${spring.version}</version>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-jdbc</artifactId>
    			<version>${spring.version}</version>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-tx</artifactId>
    			<version>${spring.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-web</artifactId>
    			<version>${spring.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>mysql</groupId>
    			<artifactId>mysql-connector-java</artifactId>
    			<version>${mysql-connector-java.version}</version>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>org.springframework</groupId>
    			<artifactId>spring-aspects</artifactId>
    			<version>${spring.version}</version>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>commons-lang</groupId>
    			<artifactId>commons-lang</artifactId>
    			<version>${commons-lang.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>org.apache.commons</groupId>
    			<artifactId>commons-lang3</artifactId>
    			<version>${commons-lang3.version}</version>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>commons-codec</groupId>
    			<artifactId>commons-codec</artifactId>
    			<version>${commons-codec.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>commons-net</groupId>
    			<artifactId>commons-net</artifactId>
    			<version>${commons-net.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>commons-io</groupId>
    			<artifactId>commons-io</artifactId>
    			<version>${commons-io.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>commons-collections</groupId>
    			<artifactId>commons-collections</artifactId>
    			<version>${commons-collections.version}</version>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>javax.servlet</groupId>
    			<artifactId>javax.servlet-api</artifactId>
    			<version>${servlet-api.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>com.alibaba</groupId>
    			<artifactId>fastjson</artifactId>
    			<version>${fastjson.version}</version>
    		</dependency>
    
    		
    		<dependency>
    			<groupId>com.github.oshi</groupId>
    			<artifactId>oshi-core</artifactId>
    			<version>${oshi-core.version}</version>
    		</dependency>
    		
    		
    		<dependency>
    			<groupId>org.springframework.data</groupId>
    			<artifactId>spring-data-redis</artifactId>
    			<version>${spring-data-redis.version}</version>
    		</dependency>
    		
    		<dependency>
    			<groupId>redis.clients</groupId>
    			<artifactId>jedis</artifactId>
    			<version>${jedis.version}</version>
    		</dependency>
    	</dependencies>

在其他业务模块调用mapper封装组件

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20190927090238375.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n,size_16,color_FFFFFF,t_70