更改为构造注入并完善方法注释

2025-10-12 14:10:00 +08:00
parent 4538ce0050
commit 06e88b5bad
94 changed files with 557 additions and 733 deletions
--- a/common/src/main/java/com/jeesite/common/codec/DigestUtils.java
+++ b/common/src/main/java/com/jeesite/common/codec/DigestUtils.java
@@ -61,7 +61,6 @@ public class DigestUtils {
 	 * @param algorithm 散列算法（"SHA-1"、"MD5"、"SM3"）
 	 * @param salt 可为空
 	 * @param iterations 迭代次数
-	 * @return
 	 */
 	public static byte[] digest(byte[] input, String algorithm, byte[] salt, int iterations) {
 		try {
--- a/common/src/main/java/com/jeesite/common/io/ResourceUtils.java
+++ b/common/src/main/java/com/jeesite/common/io/ResourceUtils.java
@@ -53,9 +53,7 @@ public class ResourceUtils extends org.springframework.util.ResourceUtils {
 	
 	/**
 	 * 获取资源文件流（用后记得关闭）
-	 * @param location
 	 * @author ThinkGem
-	 * @throws IOException 
 	 */
 	public static InputStream getResourceFileStream(String location) throws IOException{
 		Resource resource = resourceLoader.getResource(location);
@@ -64,7 +62,6 @@ public class ResourceUtils extends org.springframework.util.ResourceUtils {
 	
 	/**
 	 * 获取资源文件内容
-	 * @param location
 	 * @author ThinkGem
 	 */
 	public static String getResourceFileContent(String location){
@@ -77,7 +74,6 @@ public class ResourceUtils extends org.springframework.util.ResourceUtils {
 	
 	/**
 	 * Spring 搜索资源文件
-	 * @param locationPattern
 	 * @author ThinkGem
 	 */
 	public static Resource[] getResources(String locationPattern){
--- a/common/src/main/java/com/jeesite/common/lang/ByteUtils.java
+++ b/common/src/main/java/com/jeesite/common/lang/ByteUtils.java
@@ -15,7 +15,6 @@ public class ByteUtils {

    /**
     * @param byteSize 字节
-     * @return
     */
    public static String formatByteSize(long byteSize) {
    	
--- a/common/src/main/java/com/jeesite/common/lang/DateUtils.java
+++ b/common/src/main/java/com/jeesite/common/lang/DateUtils.java
@@ -84,7 +84,6 @@ public class DateUtils extends org.apache.commons.lang3.time.DateUtils {
 	 * @param pattern 格式（yyyy-MM-dd） pattern可以为："yyyy-MM-dd" "HH:mm:ss" "E"
 	 * @param amont 数量，前为负数，后为正数
 	 * @param type 类型，可参考Calendar的常量(如：Calendar.HOUR、Calendar.MINUTE、Calendar.SECOND)
-	 * @return
 	 */
 	public static String getDate(String pattern, int amont, int type) {
 		Calendar calendar = Calendar.getInstance(LocaleUtils.getTimeZone(), LocaleUtils.getLocale());
--- a/common/src/main/java/com/jeesite/common/lang/ObjectUtils.java
+++ b/common/src/main/java/com/jeesite/common/lang/ObjectUtils.java
@@ -31,7 +31,7 @@ public class ObjectUtils extends org.apache.commons.lang3.ObjectUtils {
 		String[] ver = StringUtils.split(System.getProperty("java.version"), StringUtils.DOT);
 		isJavaSerialize = ver.length > 0 && Integer.parseInt(ver[0]) > 1;
 	}
-	
+
 	/**
 	 * 转换为 Double 类型
 	 */
@@ -150,8 +150,8 @@ public class ObjectUtils extends org.apache.commons.lang3.ObjectUtils {

 	/**
 	 * 拷贝一个对象（但是子对象无法拷贝）
-	 * @param source
-	 * @param ignoreProperties
+	 * @param source 原对象
+	 * @param ignoreProperties 忽略的属性
 	 */
 	public static Object copyBean(Object source, String... ignoreProperties){
 		if (source == null){
@@ -169,7 +169,7 @@ public class ObjectUtils extends org.apache.commons.lang3.ObjectUtils {
 	
 	/**
 	 * 克隆一个对象（完全拷贝）
-	 * @param source
+	 * @param source 原对象
 	 */
 	public static Object cloneBean(Object source){
 		if (source == null){
@@ -181,8 +181,6 @@ public class ObjectUtils extends org.apache.commons.lang3.ObjectUtils {
 	
 	/**
 	 * 序列化对象
-	 * @param object
-	 * @return
 	 */
 	public static byte[] serialize(Object object) {
 		try {
@@ -199,8 +197,6 @@ public class ObjectUtils extends org.apache.commons.lang3.ObjectUtils {

 	/**
 	 * 反序列化对象
-	 * @param bytes
-	 * @return
 	 */
 	public static Object unserialize(byte[] bytes) {
 		try {
@@ -217,8 +213,6 @@ public class ObjectUtils extends org.apache.commons.lang3.ObjectUtils {
 	
 	/**
 	 * 序列化对象
-	 * @param object
-	 * @return
 	 */
 	public static byte[] serializeJava(Object object) {
 		if (object == null){
@@ -242,8 +236,6 @@ public class ObjectUtils extends org.apache.commons.lang3.ObjectUtils {

 	/**
 	 * 反序列化对象
-	 * @param bytes
-	 * @return
 	 */
 	public static Object unserializeJava(byte[] bytes) {
 		if (bytes == null){
--- a/common/src/main/java/com/jeesite/common/lang/WorkDayUtils.java
+++ b/common/src/main/java/com/jeesite/common/lang/WorkDayUtils.java
@@ -10,9 +10,6 @@ public class WorkDayUtils {

 	/**
 	 * 获取日期之间的天数
-	 * @param d1
-	 * @param d2
-	 * @return
 	 */
 	public int getDaysBetween(java.util.Calendar d1, java.util.Calendar d2) {
 		if (d1.after(d2)) { // swap dates so that d1 is start and d2 is end
@@ -35,9 +32,6 @@ public class WorkDayUtils {

 	/**
 	 * 获取工作日
-	 * @param d1
-	 * @param d2
-	 * @return
 	 */
 	public int getWorkingDay(java.util.Calendar d1, java.util.Calendar d2) {
 		int result = -1;
@@ -72,8 +66,6 @@ public class WorkDayUtils {

 	/**
 	 * 获取中文日期
-	 * @param date
-	 * @return
 	 */
 	public String getChineseWeek(Calendar date) {
 		final String[] dayNames = { "星期日", "星期一", "星期二", "星期三", "星期四", "星期五", "星期六" };
@@ -84,8 +76,6 @@ public class WorkDayUtils {

 	/**
 	 * 获得日期的下一个星期一的日期
-	 * @param date
-	 * @return
 	 */
 	public Calendar getNextMonday(Calendar date) {
 		Calendar result = null;
@@ -99,9 +89,6 @@ public class WorkDayUtils {

 	/**
 	 * 获取休息日
-	 * @param d1
-	 * @param d2
-	 * @return
 	 */
 	public int getHolidays(Calendar d1, Calendar d2) {
 		return this.getDaysBetween(d1, d2) - this.getWorkingDay(d1, d2);
--- a/common/src/main/java/com/jeesite/common/media/VideoUtils.java
+++ b/common/src/main/java/com/jeesite/common/media/VideoUtils.java
@@ -146,7 +146,6 @@ public class VideoUtils {

 	/**
 	 * 检查文件是否存在
-	 * @param inputFile
 	 * @return boolean
 	 */
 	public boolean checkfile(String inputFile) {
@@ -160,8 +159,7 @@ public class VideoUtils {

 	/**
 	 * ffmpeg 截取缩略图
-	 * @param inputFile
-	 * @return boolean  
+	 * @return boolean
 	 */
 	public boolean processFfmpegCutpic(String inputFile, String outputFile) {
 		List<String> command = new java.util.ArrayList<String>();
@@ -274,8 +272,7 @@ public class VideoUtils {

 	/**
 	 * 执行命令
-	 * @param command
-	 * @return boolean  
+	 * @return boolean
 	 */
 	private boolean process(List<String> command) {
 		try {
--- a/common/src/main/java/com/jeesite/common/msg/EmailUtils.java
+++ b/common/src/main/java/com/jeesite/common/msg/EmailUtils.java
@@ -21,7 +21,6 @@ public class EmailUtils {

 	/**
 	 * 发送邮件
-	 * @return
 	 */
 	public static boolean send(String toAddress, String subject, String content) {
 		PropertiesUtils props = PropertiesUtils.getInstance();
@@ -52,7 +51,6 @@ public class EmailUtils {
 	 * @param toAddress 接收地址
 	 * @param subject 标题
 	 * @param content 内容
-	 * @return
 	 */
 	public static boolean send(String fromAddress, String fromPassword, String fromHostName, Integer smtpPort,
 							   String sslOnConnect, String sslSmtpPort, String toAddress, String subject, String content) {
--- a/common/src/main/java/com/jeesite/common/network/IpUtils.java
+++ b/common/src/main/java/com/jeesite/common/network/IpUtils.java
@@ -59,7 +59,6 @@ public class IpUtils {
 	 * 172.16.0.0/12：172.16.0.0～172.31.255.255
 	 * 192.168.0.0/16：192.168.0.0～192.168.255.255
 	 * @param ip 地址
-	 * @return
 	 */
 	public static boolean isInternalAddr(String ip) {

--- a/common/src/main/java/com/jeesite/common/utils/excel/ExcelImport.java
+++ b/common/src/main/java/com/jeesite/common/utils/excel/ExcelImport.java
@@ -235,7 +235,6 @@ public class ExcelImport implements Closeable {

 	/**
 	 * 获取行对象
-	 * @param rownum
 	 * @return 返回Row对象，如果空行返回null
 	 */
 	public Row getRow(int rownum){
@@ -262,7 +261,6 @@ public class ExcelImport implements Closeable {

 	/**
 	 * 获取数据行号
-	 * @return
 	 */
 	public int getDataRowNum(){
 		return headerNum;
@@ -270,7 +268,6 @@ public class ExcelImport implements Closeable {
 	
 	/**
 	 * 获取最后一个数据行号
-	 * @return
 	 */
 	public int getLastDataRowNum(){
 		//return this.sheet.getLastRowNum() + headerNum;
@@ -279,7 +276,6 @@ public class ExcelImport implements Closeable {
 	
 	/**
 	 * 获取最后一个列号
-	 * @return
 	 */
 	public int getLastCellNum(){
 		Row row = this.getRow(headerNum);
--- a/common/src/main/java/com/jeesite/common/utils/word/BookMark.java
+++ b/common/src/main/java/com/jeesite/common/utils/word/BookMark.java
@@ -59,8 +59,6 @@ public class BookMark {

 	/**
 	 * 构造函数
-	 * @param ctBookmark
-	 * @param para
 	 */
 	public BookMark(CTBookmark ctBookmark, XWPFParagraph para) {
 		this._ctBookmark = ctBookmark;
@@ -72,9 +70,6 @@ public class BookMark {

 	/**
 	 * 构造函数，用于表格中的标签
-	 * @param ctBookmark
-	 * @param para
-	 * @param tableCell
 	 */
 	public BookMark(CTBookmark ctBookmark, XWPFParagraph para, XWPFTableCell tableCell) {
 		this(ctBookmark, para);
--- a/common/src/main/java/com/jeesite/common/web/http/UserAgentUtils.java
+++ b/common/src/main/java/com/jeesite/common/web/http/UserAgentUtils.java
@@ -19,8 +19,6 @@ public class UserAgentUtils {

 	/**
 	 * 获取用户代理对象
-	 * @param request
-	 * @return
 	 */
 	public static UserAgent getUserAgent(HttpServletRequest request){
 		return UserAgent.parseUserAgentString(request.getHeader("User-Agent"));
@@ -28,8 +26,6 @@ public class UserAgentUtils {
 	
 	/**
 	 * 获取设备类型
-	 * @param request
-	 * @return
 	 */
 	public static DeviceType getDeviceType(HttpServletRequest request){
 		return getUserAgent(request).getOperatingSystem().getDeviceType();
@@ -37,8 +33,6 @@ public class UserAgentUtils {
 	
 	/**
 	 * 是否是PC
-	 * @param request
-	 * @return
 	 */
 	public static boolean isComputer(HttpServletRequest request){
 		return DeviceType.COMPUTER.equals(getDeviceType(request));
@@ -46,8 +40,6 @@ public class UserAgentUtils {

 	/**
 	 * 是否是手机
-	 * @param request
-	 * @return
 	 */
 	public static boolean isMobile(HttpServletRequest request){
 		return DeviceType.MOBILE.equals(getDeviceType(request));
@@ -55,8 +47,6 @@ public class UserAgentUtils {
 	
 	/**
 	 * 是否是平板
-	 * @param request
-	 * @return
 	 */
 	public static boolean isTablet(HttpServletRequest request){
 		return DeviceType.TABLET.equals(getDeviceType(request));
@@ -64,8 +54,6 @@ public class UserAgentUtils {

 	/**
 	 * 是否是手机和平板
-	 * @param request
-	 * @return
 	 */
 	public static boolean isMobileOrTablet(HttpServletRequest request){
 		DeviceType deviceType = getDeviceType(request);
@@ -74,8 +62,6 @@ public class UserAgentUtils {
 	
 	/**
 	 * 获取浏览类型
-	 * @param request
-	 * @return
 	 */
 	public static Browser getBrowser(HttpServletRequest request){
 		return getUserAgent(request).getBrowser();
@@ -83,8 +69,6 @@ public class UserAgentUtils {
 	
 	/**
 	 * 是否IE版本是否小于等于IE8
-	 * @param request
-	 * @return
 	 */
 	public static boolean isLteIE8(HttpServletRequest request){
 		Browser browser = getBrowser(request);
--- a/common/src/test/java/com/jeesite/test/CodeStatistic.java
+++ b/common/src/test/java/com/jeesite/test/CodeStatistic.java
@@ -48,8 +48,6 @@ public class CodeStatistic {
 	
 	/**
 	 * 获得目录下的文件和子目录下的文件
-	 * @param f
-	 * @return
 	 */
 	public static ArrayList<File> getFile(File f) {
 		File[] ff = f.listFiles();
@@ -66,7 +64,6 @@ public class CodeStatistic {

 	/**
 	 * 统计方法
-	 * @param f
 	 */
 	private static void count(File f) {
 		FileReader fr = null;