मॉड्यूलर आर्किटेक्चर एप्लिकेशन में "सरल" ईमेल भेजने वाले मॉड्यूल को लागू करने के लिए श्रम लागत

Php पर, मेल भेजने को कोड की एक लाइन के साथ लागू किया जाता है! और जावा पर- आपको 3 सप्ताह की आवश्यकता है ??! (डेवलपर्स और प्रबंधकों के साथ बातचीत से)

लेख जावा में मेल भेजने के तरीके के बारे में नहीं है। मेरा लक्ष्य बड़े अनुप्रयोगों (उदाहरण के लिए, ईआरपी नदी के विकास) के मॉड्यूलर विकास की जटिलता को दिखाना है।

तो, कार्य: ईमेल भेजने सेवा (युद्ध) को लागू करने के लिए।

विकास के चरण:

भेजने से शुरू करते हैं

यदि स्प्रिंग नहीं है (एक छोटे मॉड्यूल के लिए इसकी आवश्यकता नहीं है), तो हम अपाचे कॉमन्स-ईमेल कनेक्ट करते हैं

<dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-email</artifactId> <version>1.3</version> </dependency> 

और लिखो

  public class MailSender { public static void sendMail { HtmlEmail email = ... ? email.send(); 

क्षमा करें, मुझे मेल सर्वर सेटिंग्स कहां मिल सकती हैं? उन्हें हार्डकोड, मुझे लगता है, यह एक जूनियर डेवलपर के लिए भी नहीं होगा, इसलिए:

मेल सर्वर कॉन्फ़िगरेशन

मुझे उम्मीद है कि हमने पहले ही पूरे सिस्टम को कॉन्फ़िगर करने का सामान्य काम पूरा कर लिया है, और हम इसे केवल मेल मॉड्यूल के लिए लागू कर सकते हैं:

  ... <part key="email"> <entry key="hostName">smtp.gmail.com</entry> <entry key="user">sendmail@mycompany.ru</entry> <entry key="password">psw</entry> <entry key="smtpPort">465</entry> <entry key="useSSL">true</entry> <entry key="debug">false</entry> <entry key="charset">UTF-8</entry> <entry key="useTLS">false</entry> </part> 

  public class MailConfig { public static <T extends Email> T prepareEmail(T email) { email.setHostName(hostName); email.setSmtpPort(port); email.setSSL(useSSL); email.setTLS(useTLS); email.setDebug(debug); email.setAuthenticator(defaultAuthenticator); email.setCharset(charset); return email; } 

सेवा कॉल

हाँ, हमारे पास एक सेवा है, हम इसे कैसे कॉल करना चाहते हैं?
व्यवसाय वेब सेवाओं के साथ एकीकरण चाहता है, और आपको अभी भी सरल HTTP जीईटी (उदाहरण के लिए, ब्राउज़र से सीधे कॉल) के माध्यम से भेजने की आवश्यकता है:

• HTTP GET के माध्यम से भेजा जा रहा है:
  

    public class MailServlet extends CommonServlet { @Override protected void doProcess(HttpServletRequest request, HttpServletResponse response, Map<String, String> params) throws IOException, ServletException { String from = ConfigUtil.getProperty("from", params); ... MailSender.sendMail(from, to, cc, ..); 

  
  
• एक लहर सेवा (JAX-WS) को लागू करना अधिक जटिल है:
  
  

    @WebService @SOAPBinding(style = Style.RPC) public interface MailService { @WebMethod public void sendMail( @WebParam(name = "from") String from, @WebParam(name = "to") String to, @WebService(endpointInterface = "mycompany.MailService") public class MailServiceImpl implements MailService { @Override public void sendMail(String from, String to, String cc, String subject, String body, String attachmentUrls) throws StateException { MailSender.sendMailAndRecordHistory(from, to, cc, subject, body, ..); } 

  
  और mailService.wsdl:
  

    <definitions .. targetNamespace="http://mail.mycompany.com/" name="MailServiceImplService"> <message name="sendMail"> <part name="from" type="xsd:string"/> ... <portType name="MailService"> <operation name="sendMail" parameterOrder="from to cc subject body attachmentUrls"> <input wsam:Action="http://mail.mycompany.com/MailService/sendMailRequest" message="tns:sendMail"/> ... <binding name="MailServiceImplPortBinding" type="tns:MailService"> <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="rpc"/> <operation name="sendMail"> <soap:operation soapAction=""/> ... <service name="MailServiceImplService"> <port name="MailServiceImplPort" binding="tns:MailServiceImplPortBinding"> <soap:address location="http://mycompany:8080/mail/mailService"/> ... 

  
  Web.xml (टॉमकैट) मत भूलना
  

    <listener> <listener-class>com.sun.xml.ws.transport.http.servlet.WSServletContextListener</listener-class> </listener> <servlet> <servlet-name>mailService</servlet-name> <servlet-class>com.sun.xml.ws.transport.http.servlet.WSServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>mailService</servlet-name> <url-pattern>/mailService</url-pattern> </servlet-mapping> <servlet> <servlet-name>mailServlet</servlet-name> <servlet-class>com.mycompany.mail.MailServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> ... 

मेल-क्लाइंट का आवंटन

और अब हमारे सिस्टम का पड़ोसी मॉड्यूल वेब सेवा पर हमारी सेवा को जल्दी कैसे खींच सकता है? सबसे आसान तरीका मावेन मेल-क्लाइंट मॉड्यूल का चयन करना है, हमारी मेल सेवा को इस पर निर्भर बनाना है, और किसी भी मॉड्यूल को अनुमति देना है - हमारे क्लाइंट को (मावेन निर्भरता) मेल-क्लाइंट को शामिल करना है:

• हम एक अलग मावेन मेल-क्लाइंट मॉड्यूल बनाते हैं और इसमें मेलस्वाइट्सडीडीएल और इंटरफ़ेस मेलसेवाइन डालते हैं
  

    <groupId>com.mycompany</groupId> <artifactId>mail-client</artifactId> <name>Mail Client</name> 

  
  
• इसके अलावा, हमारे आंतरिक ग्राहक के पूर्ण आनंद के लिए, हम MailWSClient बनाते हैं:
  पड़ोसी मॉड्यूल को कॉल करना काफी सरल होगा:
  

   MailWSClient.sendMail(... 

  
  

    public class MailWSClient { static String mailWsdl; private static final Service SERVICE; static { URL url = MailWSClient.class.getClassLoader().getResource("mailService.wsdl"); SERVICE = Service.create(url, new QName("http://mail.mycompany.com/", "MailServiceImplService")); // get mail endpoint from config mailWsdl = Config.getUrlAsString("mail/mailService?wsdl"); } public static void sendMail(String from, String to, ..){ getPort().sendMail(from, .. private static MailService getPort() { MailService port = SERVICE.getPort(MailService.class); Map<String, Object> requestContext = ((BindingProvider) port).getRequestContext(); requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, mailWsdl); return port; } 

हम पैटर्न को तेज करते हैं

Ege। दस्तावेज़ प्रबंधन मॉड्यूल में हमारे पास 52 प्रकार के दस्तावेज़ हैं। यह अच्छा होगा यदि हमारे ग्राहकों को पत्र टेम्पलेट स्वयं निर्धारित करने का अवसर दिया जाए। इसके अलावा, ऐसी सेवा (टेम्प्लेट सर्विस) पहले ही लागू की जा चुकी है।
टेम्प्लेट सेवा सरल है: जेएसपी पर लागू की जाती है, कुंजी प्राप्त करके और पैरामीटर इसे भेजे जाते हैं, समाप्त पाठ वापस आ जाता है।

• MailService, MailWSClient, MailServiceImpl, MailSender, mailService.wsdl और MailServlet पर SendTemplateMail जोड़ें:
  

   sendTemplateMail(.., templateKey, params); 

• और हम इसे MailSender में लागू करते हैं (हमारे पास पहले से ही एक सुविधाजनक आवरण MyHttpConnection है जिसे HttpURLConnection.openConnection () के माध्यम से लागू किया गया है)
  

    static void sendTemplateMail(..., String key, String params) { LOGGER.info("Send template mail from ... String templateUrl = getUrlAsString("template?type=mail&format=html&key=" + key ... MyHttpConnection conn = MyHttpConnection.connect(templateUrl, params); if (conn.isOk()) { String body = conn.getMsg(); sendMail(from, to, cc, MailUtil.getSubject(body), body); } else { throw LOGGER.getStateException(conn.toString(), ExceptionType.TEMPLATE); ... 

  
  रास्ते के साथ, मुझे विषय के साथ समस्या को हल करना था: टेम्पलेट सेवा केवल संदेश निकाय देता है। टेम्पलेट को HTML प्रारूप में लौटाया गया है, MailUtil टेम्पलेट से टिल्ट निकालता है और इसे विषय के रूप में उपयोग करता है:
  
  

    public class MailUtil { static Pattern MAIL_TITLE = Pattern.compile("<title>(.+)</title>", Pattern.MULTILINE); static String getSubject(String template) { Matcher m = MAIL_TITLE.matcher(template); return m.find() ? m.group(1) : null; } 

दस्तावेज भेजना

दरअसल, हमारे पास दस्तावेज हैं। लेकिन क्या होगा अगर हम दस्तावेज़ को आईडी के साथ सेवा कहते हैं? टेम्प्लेट सर्विस में दस्तावेजों के लिए पहले से ही टेम्प्लेट मौजूद हैं।

• SendDocMail को MailService, MailWSClient, MailServiceImpl, MailSender, mailService.wsdl और MailServlet में जोड़ें।
  

   sendDocMail(String from, String to, String cc, String key, long docId); 

• अजी, और दस्तावेजों में संलग्नक हैं जो पत्र से जुड़े होने की आवश्यकता है।
  सौभाग्य से, कॉमन्स-ईमेल यह आसान बनाता है, और हमारे पास एक सामान्य मावेन अटैच-कॉमन मॉड्यूल है, जिसे आप docId के लिए अनुलग्नकों की सूची के लिए पूछ सकते हैं:
  

    public class MailSender { static void sendDocMail(String from, String to, String cc, String key, long docId) throws StateException { List<Attach> list = AttachUtil.getList(docId); MailSender.sendTemplateMailAndRecordHistory(from, to, cc, key, "objectid=" + docId, MailUtil.formatAttach(list)); } public class MailUtil { // format attaches as // ulr1[name1], ulr2[name2], ... static String formatAttach(List<Attach> list) { return Util.collectionToDelimitedString(list, new Presentable<Attach>() { @Override public String toString(Attach attach) { return AttachConfig.downloadUrl + attach.getUuid() + '[' + attach.getName() + ']'; } 

दोष सहिष्णुता

और अगर सर्वर अस्थायी रूप से अनुपलब्ध है? आपको डेटाबेस में इतिहास को सहेजने और एक पुश करने की आवश्यकता है ... उसी समय, हम बीपीएम से उसे कार्य सौंपकर उपयोगकर्ता को एक पत्र भेजने की समस्या को हल करेंगे - इसे डेटाबेस में ट्रिगर के माध्यम से लागू किया जा सकता है: तालिका में TODO रेखा डालें। एक साइड इफेक्ट के रूप में, हमारे पास अपने संदेश भेजने का इतिहास है, तो आप ऊपर से ui को हवा दे सकते हैं और मेज पर SQL प्रश्न कर सकते हैं।
यह अच्छा है कि हमारे पास पहले से ही एक स्कैनिंग तंत्र है - हमें बस एक और कार्यान्वयन की आवश्यकता है।

• हम डेटाबेस में mail_action तालिका बनाते हैं
  

    CREATE TABLE hist.mail_action ( id SERIAL, _from TEXT, _to TEXT NOT NULL, _cc TEXT, subject TEXT, body TEXT, attachmenturls TEXT, state TEXT NOT NULL, date TIMESTAMP(0) WITHOUT TIME ZONE, key reference.ui_key, params TEXT ); 

• कॉन्फ़िगरेशन में स्कैन अंतराल जोड़ें
  

    <entry key="scanTodoInterval">30</entry> <entry key="scanFailInterval">600</entry> 

  
  

   scanTodoInterval = ConfigUtil.getInt(SCAN_TODO_INTERVAL, mailProps, 60); // default 60 sec scanFailInterval = ConfigUtil.getInt(SCAN_FAIL_INTERVAL, mailProps, 600); // default 10 min 

  
  हम MailSender को राज्य (ओके या अपवाद) के साथ डेटाबेस को भेजने के इतिहास को रिकॉर्ड करने में लागू करते हैं।
  हम mail_action तालिका को स्कैन करते हैं और राज्य की स्थिति (TODO, EmailException) पर आधारित एक ईमेल भेजते हैं
  

    <listener> <listener-class>com.mycompany.common.web.SchedulerListener</listener-class> </listener> 

  
  

    public class MailWebScanner implements WebScheduler { private final MailScanner todoScanner = new MailScanner("TODO"); private final MailScanner failScanner = new MailScanner("org.apache.commons.mail.EmailException"); @Override public void activate(ServletContext servletContext) { todoScanner.startScanning(MailConfig.scanTodoInterval); failScanner.startScanning(MailConfig.scanFailInterval); } @Override public void deactivate() { todoScanner.deactivate(); failScanner.deactivate(); } @Override public void shutdown() { AsyncExecutor.shutdown(); } } public class MailScanner extends Scanner { private static final BeanListHandler<MailBean> HANDLER = new BeanListHandler<MailBean>(MailBean.class); private final String startWith; public MailScanner(String startWith) { this.startWith = startWith; } void startScanning(int interval) { activate(new Runnable() { @Override public void run() { for (MailBean mail : getMailToSend()) { MailSender.sendTemplateMailAndRecordHistory( } } }, interval, false); } ... List<MailBean> getMailToSend() { return SqlUtil.executeQuery("select * from hist.mail_action where state like '" + startWith + "%'", HANDLER); ... 

उन लोगों के लिए जो इंतजार करना पसंद नहीं करते हैं: अतुल्यकालिक

चूंकि हमारी सेवा अब विफलताओं के लिए प्रतिरोधी है, इसलिए हमारी वेब सेवा के हमारे ग्राहक उत्तर की प्रतीक्षा न करें। Async पोस्टफ़िक्स और @OneWay एनोटेशन के साथ सभी सेवा विधियों को डुप्लिकेट करने के बजाय, हम MailyncClient कॉल में Async फ़्लैग और AsyncExecutor (शेड्यूल किए गए हमारे शेड्यूलर TopTreadPoolExecutor) को जोड़ते हैं:

  public class MailWSClient { public static void sendMail(final String from, final String to, final String cc, final String subject, final String body, final String attachmentUrls, boolean async) throws StateException { send(new Runnable() { @Override public void run() { getPort().sendMail(mask(from), mask(to), mask(cc), mask(subject), mask(body), mask(attachmentUrls)); } }, async); } public static void sendTemplateMail(final String from, final String to, final String cc, final String key, final String params, final String attachmentUrls, boolean async) throws StateException { ... public static void sendDocMail(final String from, final String to, final String cc, final String key, final long docId, boolean async) throws StateException { ... private static void send(Runnable task, boolean async) { if (async) { AsyncExecutor.submit(task); } else { task.run(); } } 

छवि संलग्नक ठीक करें

खैर, सब कुछ काम करता है! अंत में, आप बग्स को ठीक कर सकते हैं - पत्र में चित्र हमारे इंट्रानेट के बाहर दिखाई नहीं दे रहे हैं ... आखिरकार, वे <img src = "हमारे आंतरिक संसाधनों" के माध्यम से टेम्पलेट्स में सेट हैं, निश्चित रूप से, आप उन्हें बाकी दुनिया में नहीं देखेंगे।

हम उन्हें निर्मित करते हैं:

  public class MailSender { static void sendMailAndRecordHistory(String from, String to, String cc, String key, String params, String attachmentUrls, long docId) throws StateException { ... String embedImgBody = MailUtil.embedImg(body, email); public class MailUtil { static final Pattern HTML_URL = Pattern.compile("<img src=(?:\"|')(.+)(?:\"|')", Pattern.CASE_INSENSITIVE | Pattern.MULTILINE); public static String embedImg(String body, final HtmlEmail email) throws EmailException { return StringUtil.resolveReplacement(body, HTML_URL, new Presentable<Matcher>() { @Override public String toString(Matcher matcher) { String url = matcher.group(1); cid = email.embed(url, UUID.nameUUIDFromBytes(url.getBytes()).toString()); } return "<img src=\"cid:" + cid + "\""; ... 

हम बिल्ट-इन (डेटा: इमेज / पीएनजी; बेस 64, एनकोडेड_मग) बड़ी तस्वीरें भेजते हैं

एक नया व्यापार विचार गलती से ग्राहक के ब्राउज़र से मेल का समर्थन करने के लिए स्क्रीनशॉट भेजना है।
यूआई पर समाधान पाया जाता है - चाल हमारी है। टेम्प्लेट सेवा के लिए, error_mail.jsp टेम्प्लेट लिखें

  <%@page pageEncoding="UTF-8" %> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Error Report</title> </head> <body> <h2>Error Report from '${user}'</h2> <b>Message:</b> <pre> ${message} </pre> <b>Screenshot:</b><br> <img src="${screenshot}"> </body> </html> 

टेम्पलेट पैरामीटर - अपवाद संदेश और base64_encoded_screenshot - हमारी सेवा से टेम्प्लेट सेवा में भेजे जाते हैं। हमें समस्याएँ हैं: हमारे स्व-लिखित आवरण MyHttpConnection, GET के माध्यम से base64_encoded_screenshot नहीं भेज सकता है। आपको POST करना होगा और URLEncoder.encode को फिर से "+" की समस्याओं के कारण करना होगा। इसके अलावा, इनलाइन मेल में तस्वीर दिखाई नहीं दे रही है :( ठीक है, आपको इसे भी संलग्न करना होगा:

  public class MailUtil { static Pattern DATA_PROTOCOL = Pattern.compile("^data:(.+);(.+),"); public static String embedImg(String body, final HtmlEmail email) throws EmailException { return StringUtil.resolveReplacement(body, HTML_URL, new Presentable<Matcher>() { @Override public String toString(Matcher matcher) { String url = matcher.group(1); String cid; try { Matcher m = DATA_PROTOCOL.matcher(url); if (m.find()) { final String cType = m.group(1); final String encoding = m.group(2); final String content = url.substring(m.toMatchResult().end()); cid = email.embed(new javax.activation.DataSource() { @Override public InputStream getInputStream() throws IOException { try { return javax.mail.internet.MimeUtility.decode(new ByteArrayInputStream(IOUtil.getBytes(content)), encoding); } catch (MessagingException e) { throw LOGGER.getIllegalStateException("Image encoding failed", e); } } // empty realization for other javax.activation.DataSource methods ... }, UUID.randomUUID().toString()); } else { cid = email.embed(url, UUID.nameUUIDFromBytes(url.getBytes()).toString()); } return "<img src=\"cid:" + cid + "\""; ... 

अंतिम बिंदु: सुरक्षा

हालांकि, कोई भी उपयोगकर्ता ब्राउज़र से एक अनुरोध प्राप्त करता है और एक शीर्ष गुप्त दस्तावेज़ के साथ एक ईमेल प्राप्त करता है। यह अच्छा नहीं है। पास किए गए docId के साथ डॉक्यूमेंट के लिए यूजर एक्सेस चेक को फास्ट करना आवश्यक है और आम तौर पर चेक करें: यदि रिक्वेस्ट गेट के माध्यम से आया है, तो क्या उपयोगकर्ता हमारे सिस्टम में लॉग इन है।
इस तथ्य के कारण कि लॉगिन वाला पृष्ठ पहले से ही किया गया है और इसके चारों ओर बहुत सारी गतिविधि थी, और हमारे पास सिस्टम में केवल एक प्रवेश बिंदु है, मैंने स्वयं मॉड्यूल के बीच सर्वर अनुरोधों में विश्वास के साथ REST और डोमेन-स्तरीय कुकीज़ के माध्यम से एक जांच की, लेकिन यह पहले से ही है - अलग लेख।

एक साधारण मेल भेजने वाले कार्य का सारांश:

परिणाम कक्षाओं के साथ 2 मावेन मॉड्यूल थे (बुनियादी ढांचे की गिनती नहीं करना जैसे कि कॉन्फ़िगरेशन, अटैचमेंट, टेम्प्लेट, सामान्य भाग और JUititments)

• मेल-ग्राहक
  
  • MailService: इंटरफ़ेस (sendMail, sendTemplateMail, sendDocMail)
  • MailWSClient: कॉन्फ़िगरेशन से एंडपॉइंट को उजागर करने वाले क्लाइंट के लिए एक आवरण
  • mailService.wsdl
  
  
• मेल-सेवा
  
  • MailSender: खुद भेज रहा है
  • MailServiceImpl: वेब सेवा कार्यान्वयन, MailSender के लिए प्रतिनिधिमंडल
  • MailServlet: HTTP GET को संभालने के लिए सर्वलेट
  • MailBean: डेटाबेस से एक स्ट्रिंग पढ़ने के लिए सेम कॉमन्स-डबल्स के माध्यम से
  • MailConfig: कॉन्फ़िगरेशन
  • MailScanner: स्टेटस भेजकर टेबल को स्कैन करें
  • MailWebScanner: हमारी सेवा के लिए श्रोता का कार्यान्वयन जो 2 MailScanner स्कैनर लॉन्च करता है
  • MailUtil: यूटिलिटी मेथड्स
  • EmailExceptionHandler: अपवादों को संभालना, AddressException द्वारा संबोधित नहीं किया गया
  • sun-jaxws.xml, web.xml
  
  

एक रोगी पाठक, जो लेख के अंत तक पहुँच गया है, वह खुद "मेल भेजने वाले कार्य" के लिए श्रम लागतों की संख्या और परिणामी कार्यान्वयन की तुलना कर सकता है। आपका ध्यान देने के लिए धन्यवाद।

---

संदर्भ:

• Apache Email उपयोगकर्ता पुस्तिका
• अपाचे dbutils उदाहरण हैं
• स्क्रीनशॉट पीढ़ी
• ईआरपी नदी