Redpacket.java

package com.foxinmy.weixin4j.pay.payment.mch;

import com.alibaba.fastjson.annotation.JSONField;
import com.foxinmy.weixin4j.pay.type.mch.RedpacketSceneType;
import com.foxinmy.weixin4j.util.DateUtil;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

/**
 * 红包
 *
 * @className Redpacket
 * @author jinyu(foxinmy@gmail.com)
 * @date 2015年3月28日
 * @since JDK 1.6
 * @see <a
 *      href="https://pay.weixin.qq.com/wiki/doc/api/tools/cash_coupon.php?chapter=13_1">普通红包</a>
 * @see <a
 *      href="https://pay.weixin.qq.com/wiki/doc/api/tools/cash_coupon.php?chapter=16_1">裂变红包</a>
 */
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class Redpacket extends MerchantResult {

	private static final long serialVersionUID = -7021352305575714281L;

	/**
	 * 商户订单号（每个订单号必须唯一） 组成： mch_id+yyyymmdd+10位一天内不能重复的数字。
	 */
	@XmlElement(name = "mch_billno")
	@JSONField(name = "mch_billno")
	private String outTradeNo;
	/**
	 * 接受收红包的用户的openid 必填
	 */
	@XmlElement(name = "re_openid")
	@JSONField(name = "re_openid")
	private String openId;
	/**
	 * 红包发送者名称 必填
	 */
	@XmlElement(name = "send_name")
	@JSONField(name = "send_name")
	private String sendName;
	/**
	 * 付款金额，单位分
	 */
	@XmlElement(name = "total_amount")
	@JSONField(name = "total_amount")
	private int totalAmount;
	/**
	 * 红包发放总人数
	 */
	@XmlElement(name = "total_num")
	@JSONField(name = "total_num")
	private int totalNum;
	/**
	 * 红包金额设置方式(裂变红包) ALL_RAND—全部随机,商户指定总金额和红包发放总人数，由微信支付随机计算出各红包金额
	 */
	@XmlElement(name = "amt_type")
	@JSONField(name = "amt_type")
	private String amtType;
	/**
	 * 红包祝福语
	 */
	private String wishing;
	/**
	 * ip地址
	 */
	@XmlElement(name = "client_ip")
	@JSONField(name = "client_ip")
	private String clientIp;
	/**
	 * 活动名称
	 */
	@XmlElement(name = "act_name")
	@JSONField(name = "act_name")
	private String actName;
	/**
	 * 备注
	 */
	private String remark;

	/**
	 * 服务商模式下触达用户时的appid(可填服务商自己的appid或子商户的appid)，服务商模式下必填，
	 * 服务商模式下填入的子商户appid必须在微信支付商户平台中先录入，否则会校验不过。 非必须
	 */
	@XmlElement(name = "msgappid")
	@JSONField(name = "msgappid")
	private String msgAppId;
	/**
	 * 扣钱方mchid,常规模式下无效，服务商模式下选填，服务商模式下不填默认扣子商户的钱.非必须
	 */
	@XmlElement(name = "consume_mch_id")
	@JSONField(name = "consume_mch_id")
	private String consumeMchId;
	/**
	 * 发放红包使用场景，红包金额大于200时必传
	 */
	@XmlElement(name = "scene_id")
	@JSONField(name = "scene_id")
	private RedpacketSceneType sceneType;
	/**
	 * 活动信息
	 */
	@XmlElement(name = "risk_info")
	@JSONField(name = "risk_info")
	private String risk;

	protected Redpacket() {
		// jaxb required
	}

	/**
	 * 红包
	 *
	 * @param outTradeNo
	 *            商户侧一天内不可重复的订单号 接口根据商户订单号支持重入 如出现超时可再调用 必填
	 * @param openId
	 *            接受收红包的用户的openid 必填
	 * @param sendName
	 *            红包发送者名称 必填
	 * @param totalAmount
	 *            付款金额 <font color="red">单位为元,自动格式化为分</font> 必填
	 * @param totalNum
	 *            红包发放总人数 大于1视为裂变红包 必填
	 * @param wishing
	 *            红包祝福语 必填
	 * @param clientIp
	 *            Ip地址 必填
	 * @param actName
	 *            活动名称 必填
	 * @param remark
	 *            备注 必填
	 */
	public Redpacket(String outTradeNo, String openId, String sendName,
			double totalAmount, int totalNum, String wishing, String clientIp,
			String actName, String remark) {
		this.outTradeNo = outTradeNo;
		this.openId = openId;
		this.sendName = sendName;
		this.totalAmount = DateUtil.formatYuan2Fen(totalAmount);
		this.totalNum = totalNum;
		this.wishing = wishing;
		this.clientIp = clientIp;
		this.actName = actName;
		this.remark = remark;
		this.amtType = totalNum > 1 ? "ALL_RAND" : null;
	}

	/**
	 * 批量发送时可能需要
	 * 
	 * @param outTradeNo
	 *            订单号
	 * @param openId
	 *            用户ID
	 * @return 红包实体
	 */
	public Redpacket copy(String outTradeNo, String openId) {
		Redpacket readpacket = new Redpacket(outTradeNo, openId, sendName,
				totalAmount, totalNum, wishing, clientIp, actName, remark);
		readpacket.setMsgAppId(msgAppId);
		readpacket.setConsumeMchId(consumeMchId);
		readpacket.setSceneType(sceneType);
		readpacket.setRisk(risk);
		return readpacket;
	}

	public String getOutTradeNo() {
		return outTradeNo;
	}

	public void setOutTradeNo(String outTradeNo) {
		this.outTradeNo = outTradeNo;
	}

	public String getOpenId() {
		return openId;
	}

	public void setOpenId(String openId) {
		this.openId = openId;
	}

	public String getSendName() {
		return sendName;
	}

	public void setSendName(String sendName) {
		this.sendName = sendName;
	}

	public int getTotalAmount() {
		return totalAmount;
	}

	public void setTotalAmount(int totalAmount) {
		this.totalAmount = totalAmount;
	}

	/**
	 * <font color="red">调用接口获取单位为分,get方法转换为元方便使用</font>
	 * 
	 * @return 元单位
	 */
	@JSONField(serialize = false)
	public double getFormatTotalAmount() {
		return totalAmount / 100d;
	}

	public int getTotalNum() {
		return totalNum;
	}

	public void setTotalNum(int totalNum) {
		this.totalNum = totalNum;
	}

	public String getWishing() {
		return wishing;
	}

	public void setWishing(String wishing) {
		this.wishing = wishing;
	}

	public String getAmtType() {
		return amtType;
	}

	public void setAmtType(String amtType) {
		this.amtType = amtType;
	}

	public String getClientIp() {
		return clientIp;
	}

	public void setClientIp(String clientIp) {
		this.clientIp = clientIp;
	}

	public String getActName() {
		return actName;
	}

	public void setActName(String actName) {
		this.actName = actName;
	}

	public String getRemark() {
		return remark;
	}

	public void setRemark(String remark) {
		this.remark = remark;
	}

	public String getMsgAppId() {
		return msgAppId;
	}

	public void setMsgAppId(String msgAppId) {
		this.msgAppId = msgAppId;
	}

	public String getConsumeMchId() {
		return consumeMchId;
	}

	public void setConsumeMchId(String consumeMchId) {
		this.consumeMchId = consumeMchId;
	}

	public RedpacketSceneType getSceneType() {
		return sceneType;
	}

	public void setSceneType(RedpacketSceneType sceneType) {
		this.sceneType = sceneType;
	}

	public String getRisk() {
		return risk;
	}

	public void setRisk(String risk) {
		this.risk = risk;
	}

	public void setRisk(RedpacketRisk risk) {
		this.risk = risk.toContent();
	}

	@Override
	public String toString() {
		return "Redpacket [outTradeNo=" + outTradeNo + ", openId=" + openId
				+ ", sendName=" + sendName + ", totalAmount=" + totalAmount
				+ ", totalNum=" + totalNum + ", amtType=" + amtType
				+ ", wishing=" + wishing + ", clientIp=" + clientIp
				+ ", actName=" + actName + ", remark=" + remark + ", msgAppId="
				+ msgAppId + ", consumeMchId=" + consumeMchId + ", sceneType="
				+ sceneType + ", risk=" + risk + ", " + super.toString() + "]";
	}
}