feat: 下载次数限制,免费额度用完后第一次需要分享,之后需要看广告

This commit is contained in:
R524809
2026-05-20 16:51:54 +08:00
parent d52339c0fa
commit 51650db04e
9 changed files with 282 additions and 225 deletions
+68 -157
View File
@@ -6,122 +6,51 @@
import { checkAndSaveImage } from './saveImage';
import tracker from './tracker';
import { addDownloadLog } from './downloadLogs';
import {
getUnlockMethod,
isDownloadLimitEnabled,
needsUnlockBeforeDownload,
recordAdUnlockSuccess,
recordDownloadSuccess,
} from './shareGuide';
// 存储键名
const STORAGE_KEY_DOWNLOAD_COUNT = 'downloadCount';
const STORAGE_KEY_DOWNLOAD_DATE = 'downloadDate';
const STORAGE_KEY_WATCHED_AD_TODAY = 'watchedAdToday';
// 导出供个人中心等使用
export { getTodayDownloadCount } from './shareGuide';
// 免费下载次数限制
const FREE_DOWNLOAD_LIMIT = 5;
/**
* 开发调试环境:本地 develop 包或开发者工具(含桌面模拟器)
* 此环境下不弹广告、不限制下载次数
*/
/** 是否跳过下载配额与激励广告(与 shareGuide.isDownloadLimitEnabled 相反) */
function isDevBypassLimits(): boolean {
try {
const env = wx.getAccountInfoSync().miniProgram.envVersion || 'release';
if (env === 'develop') {
return true;
}
if (wx.getSystemInfoSync().platform === 'devtools') {
return true;
}
} catch {
// ignore
}
return false;
return !isDownloadLimitEnabled();
}
// 激励视频广告单元ID
const AD_UNIT_ID = 'adunit-eff5626f8b68c2e0';
/**
* 获取今天的日期字符串(YYYY-MM-DD格式)
*/
function getTodayDateString(): string {
const today = new Date();
const year = today.getFullYear();
const month = String(today.getMonth() + 1).padStart(2, '0');
const day = String(today.getDate()).padStart(2, '0');
return `${year}-${month}-${day}`;
}
let rewardedVideoAd: WechatMiniprogram.RewardedVideoAd | null = null;
/**
* 获取今日下载次数(供个人中心等展示;与内部计数逻辑一致)
*/
export function getTodayDownloadCount(): number {
const today = getTodayDateString();
const downloadDate = wx.getStorageSync(STORAGE_KEY_DOWNLOAD_DATE);
// 如果不是今天,重置计数
if (downloadDate !== today) {
wx.setStorageSync(STORAGE_KEY_DOWNLOAD_COUNT, 0);
wx.setStorageSync(STORAGE_KEY_DOWNLOAD_DATE, today);
wx.setStorageSync(STORAGE_KEY_WATCHED_AD_TODAY, false);
return 0;
}
return wx.getStorageSync(STORAGE_KEY_DOWNLOAD_COUNT) || 0;
}
/**
* 增加今日下载次数
*/
function incrementDownloadCount(): void {
const today = getTodayDateString();
const count = getTodayDownloadCount();
wx.setStorageSync(STORAGE_KEY_DOWNLOAD_COUNT, count + 1);
wx.setStorageSync(STORAGE_KEY_DOWNLOAD_DATE, today);
}
/**
* 检查今日是否已观看广告
*/
function hasWatchedAdToday(): boolean {
const today = getTodayDateString();
const watchedDate = wx.getStorageSync(STORAGE_KEY_WATCHED_AD_TODAY);
return watchedDate === today;
}
/**
* 标记今日已观看广告
*/
function markWatchedAdToday(): void {
const today = getTodayDateString();
wx.setStorageSync(STORAGE_KEY_WATCHED_AD_TODAY, today);
}
/**
* 创建激励视频广告实例
*/
function createVideoAd() {
function getRewardedVideoAd(): WechatMiniprogram.RewardedVideoAd | null {
if (!wx.createRewardedVideoAd) {
return null;
}
const videoAd = wx.createRewardedVideoAd({
adUnitId: AD_UNIT_ID,
});
videoAd.onLoad(() => {
console.log('激励视频广告加载成功');
});
videoAd.onError((err) => {
console.error('激励视频广告加载失败', err);
});
return videoAd;
if (!rewardedVideoAd) {
rewardedVideoAd = wx.createRewardedVideoAd({
adUnitId: AD_UNIT_ID,
});
rewardedVideoAd.onLoad(() => {
console.log('激励视频广告加载成功');
});
rewardedVideoAd.onError((err) => {
console.error('激励视频广告加载失败', err);
});
}
return rewardedVideoAd;
}
/**
* 显示激励视频广告
* 显示激励视频广告(单例实例,与改版前 downloadPrint 内逻辑一致)
*/
function showVideoAd(): Promise<boolean> {
return new Promise((resolve) => {
const videoAd = createVideoAd();
const videoAd = getRewardedVideoAd();
if (!videoAd) {
wx.showToast({
@@ -132,48 +61,33 @@ function showVideoAd(): Promise<boolean> {
return;
}
// 显示 loading
wx.showLoading({
title: '加载中...',
mask: true,
});
// 监听广告关闭事件
videoAd.onClose((res) => {
// 隐藏 loading(如果还在显示)
const onClose: WechatMiniprogram.RewardedVideoAdOnCloseCallback = (res) => {
videoAd.offClose(onClose);
wx.hideLoading();
resolve(!!(res && res.isEnded));
};
if (res && res.isEnded) {
// 用户完整观看了广告
markWatchedAdToday();
resolve(true);
} else {
// 用户提前关闭了广告
resolve(false);
}
});
videoAd.onClose(onClose);
// 显示广告
videoAd
.show()
.then(() => {
// 广告显示成功,隐藏 loading
wx.hideLoading();
})
.catch(() => {
// 失败重试,保持 loading 显示
videoAd
.load()
.then(() => videoAd.show())
.then(() => {
// 加载成功,继续显示广告
return videoAd.show();
})
.then(() => {
// 广告显示成功,隐藏 loading
wx.hideLoading();
})
.catch((err) => {
// 最终失败,隐藏 loading 并提示
videoAd.offClose(onClose);
wx.hideLoading();
console.error('激励视频广告显示失败', err);
wx.showToast({
@@ -186,6 +100,27 @@ function showVideoAd(): Promise<boolean> {
});
}
/**
* 观看激励广告以解锁下一批下载(不执行保存)
*/
export async function tryUnlockWithRewardedAd(): Promise<boolean> {
if (isDevBypassLimits()) {
return true;
}
if (!needsUnlockBeforeDownload()) {
return true;
}
if (getUnlockMethod() !== 'ad') {
return false;
}
const watched = await showVideoAd();
if (watched) {
recordAdUnlockSuccess();
return true;
}
return false;
}
/**
* 执行下载
*/
@@ -199,7 +134,6 @@ function doDownload(
worksheetId?: string;
},
): Promise<boolean> {
// 上报下载埋点
if (options.trackerName) {
if (options.trackerMode) {
tracker.reportDownload(options.trackerName, options.trackerMode);
@@ -210,7 +144,7 @@ function doDownload(
return checkAndSaveImage(canvas).then((saved) => {
if (saved) {
incrementDownloadCount();
recordDownloadSuccess();
if (options.worksheetId) {
addDownloadLog(options.worksheetId);
}
@@ -221,13 +155,6 @@ function doDownload(
/**
* 下载打印(通用方法)
* @param canvas Canvas 实例
* @param options 配置选项
* @param options.successToast 成功提示(可选,默认:'保存成功,请在相册中查看')
* @param options.errorToast 错误提示(可选,默认:'请先生成内容')
* @param options.trackerName 埋点名称(可选)
* @param options.trackerMode 埋点模式(可选)
* @param options.worksheetId worksheet ID(可选,保存成功后更新 downloads)
*/
export async function downloadPrint(
canvas: Canvas | null,
@@ -239,7 +166,6 @@ export async function downloadPrint(
worksheetId?: string;
} = {},
): Promise<boolean> {
// 检查 canvas 是否存在
if (!canvas) {
wx.showToast({
title: options.errorToast || '请先生成内容',
@@ -252,33 +178,18 @@ export async function downloadPrint(
return doDownload(canvas, options);
}
// 获取今日下载次数
const downloadCount = getTodayDownloadCount();
const hasWatchedAd = hasWatchedAdToday();
// 如果已观看广告,直接下载
if (hasWatchedAd) {
return doDownload(canvas, options);
if (needsUnlockBeforeDownload()) {
const method = getUnlockMethod();
if (method === 'share') {
return false;
}
if (method === 'ad') {
const unlocked = await tryUnlockWithRewardedAd();
if (!unlocked) {
return false;
}
}
}
// 如果未超过免费次数,直接下载
if (downloadCount < FREE_DOWNLOAD_LIMIT) {
return doDownload(canvas, options);
}
// 超过免费次数,需要观看广告
const watched = await showVideoAd();
if (watched) {
// 观看完成,可以下载
return doDownload(canvas, options);
}
/* else {
// 未观看完成,提示用户
wx.showToast({
title: '需要完整观看广告才能下载',
icon: 'none',
duration: 2000,
});
} */
return false;
return doDownload(canvas, options);
}
+135 -36
View File
@@ -1,15 +1,28 @@
/**
* 分享引导工具
* 用于控制每日免费下载次数和分享引导
* 分享引导与下载配额
* - 当日第 1 次满批:须分享解锁,弹窗引导,不分享不可下载
* - 当日第 2 次及以后满批:直接播放激励广告解锁
*/
import {
downloadFreeBatchSize,
enableDownloadLimitInDevelop,
} from '../config/config';
const STORAGE_KEY_DOWNLOAD_DATE = 'downloadDate';
const STORAGE_KEY_DOWNLOAD_COUNT = 'downloadCount';
const STORAGE_KEY_SHARED_DATE = 'sharedDate';
const STORAGE_KEY_DOWNLOADS_SINCE_UNLOCK = 'downloadsSinceUnlock';
/** 当日已完成解锁次数(分享或广告各计 1 次) */
const STORAGE_KEY_DAILY_UNLOCK_COUNT = 'dailyUnlockCount';
export type DownloadUnlockMethod = 'share' | 'ad';
/** 每批免费下载次数(来自 config,至少为 1) */
export function getFreeDownloadBatchSize(): number {
const n = Number(downloadFreeBatchSize);
return Number.isFinite(n) && n >= 1 ? Math.floor(n) : 1;
}
/**
* 获取今天的日期字符串(YYYY-MM-DD格式)
*/
function getTodayDateString(): string {
const today = new Date();
const year = today.getFullYear();
@@ -18,54 +31,140 @@ function getTodayDateString(): string {
return `${year}-${month}-${day}`;
}
/**
* 检查今天是否已经下载过
* @returns true表示今天已下载过,false表示今天未下载
*/
export function hasDownloadedToday(): boolean {
/** 跨日时重置当日计数与解锁批次 */
function ensureDailyReset(): void {
const today = getTodayDateString();
const downloadDate = wx.getStorageSync(STORAGE_KEY_DOWNLOAD_DATE);
return downloadDate === today;
if (downloadDate !== today) {
wx.setStorageSync(STORAGE_KEY_DOWNLOAD_DATE, today);
wx.setStorageSync(STORAGE_KEY_DOWNLOAD_COUNT, 0);
wx.setStorageSync(STORAGE_KEY_DOWNLOADS_SINCE_UNLOCK, 0);
wx.setStorageSync(STORAGE_KEY_DAILY_UNLOCK_COUNT, 0);
}
}
/** 当日已完成解锁次数 */
export function getDailyUnlockCount(): number {
ensureDailyReset();
return wx.getStorageSync(STORAGE_KEY_DAILY_UNLOCK_COUNT) || 0;
}
function incrementDailyUnlockCount(): void {
ensureDailyReset();
const count = getDailyUnlockCount();
wx.setStorageSync(STORAGE_KEY_DAILY_UNLOCK_COUNT, count + 1);
}
/**
* 记录今天的下载成功
* 获取今日总下载次数(供个人中心等展示)
*/
export function getTodayDownloadCount(): number {
ensureDailyReset();
return wx.getStorageSync(STORAGE_KEY_DOWNLOAD_COUNT) || 0;
}
/** 当前批次内已下载次数 */
export function getDownloadsSinceUnlock(): number {
ensureDailyReset();
return wx.getStorageSync(STORAGE_KEY_DOWNLOADS_SINCE_UNLOCK) || 0;
}
/**
* 是否已达本批次上限,下载前需先解锁
*/
export function needsUnlockBeforeDownload(): boolean {
return getDownloadsSinceUnlock() >= getFreeDownloadBatchSize();
}
/**
* 当前满批时应使用的解锁方式
*/
export function getUnlockMethod(): DownloadUnlockMethod | null {
if (!isDownloadLimitEnabled() || !needsUnlockBeforeDownload()) {
return null;
}
return getDailyUnlockCount() === 0 ? 'share' : 'ad';
}
/**
* 分享或看广告成功后,重置批次计数,可再免费下载一批
*/
export function resetUnlockQuota(): void {
ensureDailyReset();
wx.setStorageSync(STORAGE_KEY_DOWNLOADS_SINCE_UNLOCK, 0);
}
/**
* 记录一次下载成功(总次数 + 当前批次次数各 +1)
*/
export function recordDownloadSuccess(): void {
ensureDailyReset();
const today = getTodayDateString();
const total = getTodayDownloadCount();
const sinceUnlock = getDownloadsSinceUnlock();
wx.setStorageSync(STORAGE_KEY_DOWNLOAD_DATE, today);
const count = wx.getStorageSync(STORAGE_KEY_DOWNLOAD_COUNT) || 0;
wx.setStorageSync(STORAGE_KEY_DOWNLOAD_COUNT, count + 1);
wx.setStorageSync(STORAGE_KEY_DOWNLOAD_COUNT, total + 1);
wx.setStorageSync(STORAGE_KEY_DOWNLOADS_SINCE_UNLOCK, sinceUnlock + 1);
}
/**
* 检查今天是否已经分享过
* @returns true表示今天已分享过,false表示今天未分享
*/
export function hasSharedToday(): boolean {
const today = getTodayDateString();
const sharedDate = wx.getStorageSync(STORAGE_KEY_SHARED_DATE);
return sharedDate === today;
}
/**
* 记录今天的分享成功
* 记录分享解锁成功
*/
export function recordShareSuccess(): void {
const today = getTodayDateString();
wx.setStorageSync(STORAGE_KEY_SHARED_DATE, today);
resetUnlockQuota();
incrementDailyUnlockCount();
}
/**
* 检查是否需要显示分享引导
* @returns true表示需要显示分享引导,false表示不需要
* 记录激励广告解锁成功
*/
export function shouldShowShareGuide(): boolean {
// 如果今天已经分享过,不需要显示引导
const env = getApp().globalData.env;
if (env === 'develop' || hasSharedToday()) {
export function recordAdUnlockSuccess(): void {
resetUnlockQuota();
incrementDailyUnlockCount();
}
function isDevelopEnv(): boolean {
try {
const env = getApp().globalData.env;
if (env === 'develop') {
return true;
}
const accountEnv =
wx.getAccountInfoSync().miniProgram.envVersion || 'release';
return accountEnv === 'develop';
} catch {
return false;
}
// 如果今天已经下载过,需要显示引导
return hasDownloadedToday();
}
/**
* 是否启用下载配额(分享引导、激励广告)
*/
export function isDownloadLimitEnabled(): boolean {
if (!isDevelopEnv()) {
return true;
}
return enableDownloadLimitInDevelop;
}
/** 当日首次满批:须分享解锁,弹分享引导窗 */
export function shouldShowShareGuide(): boolean {
return getUnlockMethod() === 'share';
}
/** 当日第 2 次及以后满批:直接播放激励广告 */
export function shouldUnlockWithAd(): boolean {
return getUnlockMethod() === 'ad';
}
/** 分享解锁弹窗文案 */
export function getShareGuidePopupCopy(): {
message: string;
hint: string;
} {
const n = getFreeDownloadBatchSize();
return {
message: `免费下载次数已用完`,
hint: '分享给好友后即可继续下载',
};
}